aiops

package module
v1.2.0 Latest Latest
Warning

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

 Go to latest Published: Jul 28, 2025 License: Apache-2.0 Imports: 43 Imported by: 0

Documentation

Overview

Package aiops provides the API client, operations, and parameter types for AWS AI Ops.

The CloudWatch investigations feature is a generative AI-powered assistant that can help you respond to incidents in your system. It uses generative AI to scan your system's telemetry and quickly surface suggestions that might be related to your issue. These suggestions include metrics, logs, deployment events, and root-cause hypotheses.

You can use API actions to create, manage, and delete investigation groups and investigation group policies. To start and manage investigations, you must use the CloudWatch console.

Index

Constants

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

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 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 AI Ops.

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

func (c *Client) CreateInvestigationGroup(ctx context.Context, params *CreateInvestigationGroupInput, optFns ...func(*Options)) (*CreateInvestigationGroupOutput, error)

Creates an investigation group in your account. Creating an investigation group is a one-time setup task for each Region in your account. It is a necessary task to be able to perform investigations.

Settings in the investigation group help you centrally manage the common properties of your investigations, such as the following:

  • Who can access the investigations

  • Whether investigation data is encrypted with a customer managed Key Management Service key.

  • How long investigations and their data are retained by default.

Currently, you can have one investigation group in each Region in your account. Each investigation in a Region is a part of the investigation group in that Region

To create an investigation group and set up CloudWatch investigations, you must be signed in to an IAM principal that has the either the AIOpsConsoleAdminPolicy or the AdministratorAccess IAM policy attached, or to an account that has similar permissions.

You can configure CloudWatch alarms to start investigations and add events to investigations. If you create your investigation group with CreateInvestigationGroup and you want to enable alarms to do this, you must use PutInvestigationGroupPolicy to create a resource policy that grants this permission to CloudWatch alarms.

For more information about configuring CloudWatch alarms to work with CloudWatch investigations, see

func (*Client) DeleteInvestigationGroup 

func (c *Client) DeleteInvestigationGroup(ctx context.Context, params *DeleteInvestigationGroupInput, optFns ...func(*Options)) (*DeleteInvestigationGroupOutput, error)

Deletes the specified investigation group from your account. You can currently have one investigation group per Region in your account. After you delete an investigation group, you can later create a new investigation group in the same Region.

func (*Client) DeleteInvestigationGroupPolicy 

func (c *Client) DeleteInvestigationGroupPolicy(ctx context.Context, params *DeleteInvestigationGroupPolicyInput, optFns ...func(*Options)) (*DeleteInvestigationGroupPolicyOutput, error)

Removes the IAM resource policy from being associated with the investigation group that you specify.

func (*Client) GetInvestigationGroup 

func (c *Client) GetInvestigationGroup(ctx context.Context, params *GetInvestigationGroupInput, optFns ...func(*Options)) (*GetInvestigationGroupOutput, error)

Returns the configuration information for the specified investigation group.

func (*Client) GetInvestigationGroupPolicy 

func (c *Client) GetInvestigationGroupPolicy(ctx context.Context, params *GetInvestigationGroupPolicyInput, optFns ...func(*Options)) (*GetInvestigationGroupPolicyOutput, error)

Returns the IAM resource policy that is associated with the specified investigation group.

func (*Client) ListInvestigationGroups 

func (c *Client) ListInvestigationGroups(ctx context.Context, params *ListInvestigationGroupsInput, optFns ...func(*Options)) (*ListInvestigationGroupsOutput, error)

Returns the ARN and name of each investigation group in the account.

func (*Client) ListTagsForResource 

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

Displays the tags associated with a CloudWatch investigations resource. Currently, investigation groups support tagging.

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

func (c *Client) PutInvestigationGroupPolicy(ctx context.Context, params *PutInvestigationGroupPolicyInput, optFns ...func(*Options)) (*PutInvestigationGroupPolicyOutput, error)

Creates an IAM resource policy and assigns it to the specified investigation group.

If you create your investigation group with CreateInvestigationGroup and you want to enable CloudWatch alarms to create investigations and add events to investigations, you must use this operation to create a policy similar to this example. 

{ "Version": "2008-10-17", "Statement": [{ "Effect": "Allow", "Principal": {
"Service": "aiops.alarms.cloudwatch.amazonaws.com" }, "Action":
["aiops:CreateInvestigation", "aiops:CreateInvestigationEvent"], "Resource":
"*", "Condition": { "StringEquals": { "aws:SourceAccount": "account-id" },
"ArnLike": { "aws:SourceArn": "arn:aws:cloudwatch:region:account-id:alarm:*" } }
}] }

func (*Client) TagResource 

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

Assigns one or more tags (key-value pairs) to the specified resource.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

You can associate as many as 50 tags with a resource.

func (*Client) UntagResource 

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

Removes one or more tags from the specified resource.

func (*Client) UpdateInvestigationGroup 

func (c *Client) UpdateInvestigationGroup(ctx context.Context, params *UpdateInvestigationGroupInput, optFns ...func(*Options)) (*UpdateInvestigationGroupOutput, error)

Updates the configuration of the specified investigation group.

type CreateInvestigationGroupInput 

type CreateInvestigationGroupInput struct {

	// Provides a name for the investigation group.
	//
	// This member is required.
	Name *string

	// Specify the ARN of the IAM role that CloudWatch investigations will use when it
	// gathers investigation data. The permissions in this role determine which of your
	// resources that CloudWatch investigations will have access to during
	// investigations.
	//
	// For more information, see [How to control what data Amazon Q has access to during investigations].
	//
	// [How to control what data Amazon Q has access to during investigations]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Investigations-Security.html#Investigations-Security-Data
	//
	// This member is required.
	RoleArn *string

	// Use this structure to integrate CloudWatch investigations with Amazon Q in chat
	// applications. This structure is a string array. For the first string, specify
	// the ARN of an Amazon SNS topic. For the array of strings, specify the ARNs of
	// one or more Amazon Q in chat applications configurations that you want to
	// associate with that topic. For more information about these configuration ARNs,
	// see [Getting started with Amazon Q in chat applications]and [Resource type defined by Amazon Web Services Chatbot].
	//
	// [Resource type defined by Amazon Web Services Chatbot]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awschatbot.html#awschatbot-resources-for-iam-policies
	// [Getting started with Amazon Q in chat applications]: https://docs.aws.amazon.com/chatbot/latest/adminguide/getting-started.html
	ChatbotNotificationChannel map[string][]string

	// Number of sourceAccountId values that have been configured for cross-account
	// access.
	CrossAccountConfigurations []types.CrossAccountConfiguration

	// Use this structure if you want to use a customer managed KMS key to encrypt
	// your investigation data. If you omit this parameter, CloudWatch investigations
	// will use an Amazon Web Services key to encrypt the data. For more information,
	// see [Encryption of investigation data].
	//
	// [Encryption of investigation data]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Investigations-Security.html#Investigations-KMS
	EncryptionConfiguration *types.EncryptionConfiguration

	// Specify true to enable CloudWatch investigations to have access to change
	// events that are recorded by CloudTrail. The default is true .
	IsCloudTrailEventHistoryEnabled *bool

	// Specify how long that investigation data is kept. For more information, see [Operational investigation data retention].
	//
	// If you omit this parameter, the default of 90 days is used.
	//
	// [Operational investigation data retention]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Investigations-Retention.html
	RetentionInDays *int64

	// Enter the existing custom tag keys for custom applications in your system.
	// Resource tags help Amazon Q narrow the search space when it is unable to
	// discover definite relationships between resources. For example, to discover that
	// an Amazon ECS service depends on an Amazon RDS database, Amazon Q can discover
	// this relationship using data sources such as X-Ray and CloudWatch Application
	// Signals. However, if you haven't deployed these features, Amazon Q will attempt
	// to identify possible relationships. Tag boundaries can be used to narrow the
	// resources that will be discovered by Amazon Q in these cases.
	//
	// You don't need to enter tags created by myApplications or CloudFormation,
	// because Amazon Q can automatically detect those tags.
	TagKeyBoundaries []string

	// A list of key-value pairs to associate with the investigation group. You can
	// associate as many as 50 tags with an investigation group. To be able to
	// associate tags when you create the investigation group, you must have the
	// cloudwatch:TagResource permission.
	//
	// Tags can help you organize and categorize your resources. You can also use them
	// to scope user permissions by granting a user permission to access or change only
	// resources with certain tag values.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateInvestigationGroupOutput 

type CreateInvestigationGroupOutput struct {

	// The ARN of the investigation group that you just created.
	Arn *string

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

type DeleteInvestigationGroupInput 

type DeleteInvestigationGroupInput struct {

	// Specify either the name or the ARN of the investigation group that you want to
	// delete.
	//
	// This member is required.
	Identifier *string
	// contains filtered or unexported fields
}

type DeleteInvestigationGroupOutput 

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

type DeleteInvestigationGroupPolicyInput 

type DeleteInvestigationGroupPolicyInput struct {

	// Specify either the name or the ARN of the investigation group that you want to
	// remove the policy from.
	//
	// This member is required.
	Identifier *string
	// contains filtered or unexported fields
}

type DeleteInvestigationGroupPolicyOutput 

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

type EndpointParameters 

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

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

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

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

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired 

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 GetInvestigationGroupInput 

type GetInvestigationGroupInput struct {

	// Specify either the name or the ARN of the investigation group that you want to
	// view.
	//
	// This member is required.
	Identifier *string
	// contains filtered or unexported fields
}

type GetInvestigationGroupOutput 

type GetInvestigationGroupOutput struct {

	// The Amazon Resource Name (ARN) of the investigation group.
	Arn *string

	// This structure is a string array. The first string is the ARN of a Amazon SNS
	// topic. The array of strings display the ARNs of Amazon Q in chat applications
	// configurations that are associated with that topic. For more information about
	// these configuration ARNs, see [Getting started with Amazon Q in chat applications]and [Resource type defined by Amazon Web Services Chatbot].
	//
	// [Resource type defined by Amazon Web Services Chatbot]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awschatbot.html#awschatbot-resources-for-iam-policies
	// [Getting started with Amazon Q in chat applications]: https://docs.aws.amazon.com/chatbot/latest/adminguide/getting-started.html
	ChatbotNotificationChannel map[string][]string

	// The date and time that the investigation group was created.
	CreatedAt *time.Time

	// The name of the user who created the investigation group.
	CreatedBy *string

	// Lists the AWSAccountId of the accounts configured for cross-account access and
	// the results of the last scan performed on each account.
	CrossAccountConfigurations []types.CrossAccountConfiguration

	// Specifies the customer managed KMS key that the investigation group uses to
	// encrypt data, if there is one. If not, the investigation group uses an Amazon
	// Web Services key to encrypt the data.
	EncryptionConfiguration *types.EncryptionConfiguration

	// Specifies whether CloudWatch investigationshas access to change events that are
	// recorded by CloudTrail.
	IsCloudTrailEventHistoryEnabled *bool

	// The date and time that the investigation group was most recently modified.
	LastModifiedAt *time.Time

	// The name of the user who created the investigation group.
	LastModifiedBy *string

	// The name of the investigation group.
	Name *string

	// Specifies how long that investigation data is kept.
	RetentionInDays *int64

	// The ARN of the IAM role that the investigation group uses for permissions to
	// gather data.
	RoleArn *string

	// Displays the custom tag keys for custom applications in your system that you
	// have specified in the investigation group. Resource tags help Amazon Q narrow
	// the search space when it is unable to discover definite relationships between
	// resources.
	TagKeyBoundaries []string

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

type GetInvestigationGroupPolicyInput 

type GetInvestigationGroupPolicyInput struct {

	// Specify either the name or the ARN of the investigation group that you want to
	// view the policy of.
	//
	// This member is required.
	Identifier *string
	// contains filtered or unexported fields
}

type GetInvestigationGroupPolicyOutput 

type GetInvestigationGroupPolicyOutput struct {

	// The Amazon Resource Name (ARN) of the investigation group that you want to view
	// the policy of.
	InvestigationGroupArn *string

	// The policy, in JSON format.
	Policy *string

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

type HTTPClient 

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

type HTTPSignerV4 

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

type ListInvestigationGroupsAPIClient 

type ListInvestigationGroupsAPIClient interface {
	ListInvestigationGroups(context.Context, *ListInvestigationGroupsInput, ...func(*Options)) (*ListInvestigationGroupsOutput, error)
}

ListInvestigationGroupsAPIClient is a client that implements the ListInvestigationGroups operation.

type ListInvestigationGroupsInput 

type ListInvestigationGroupsInput struct {

	// The maximum number of results to return in one operation. If you omit this
	// parameter, the default of 50 is used.
	MaxResults *int32

	// Include this value, if it was returned by the previous operation, to get the
	// next set of service operations.
	NextToken *string
	// contains filtered or unexported fields
}

type ListInvestigationGroupsOutput 

type ListInvestigationGroupsOutput struct {

	// An array of structures, where each structure contains the information about one
	// investigation group in the account.
	InvestigationGroups []types.ListInvestigationGroupsModel

	// Include this value in your next use of this operation to get the next set of
	// service operations.
	NextToken *string

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

type ListInvestigationGroupsPaginator 

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

ListInvestigationGroupsPaginator is a paginator for ListInvestigationGroups

func NewListInvestigationGroupsPaginator 

func NewListInvestigationGroupsPaginator(client ListInvestigationGroupsAPIClient, params *ListInvestigationGroupsInput, optFns ...func(*ListInvestigationGroupsPaginatorOptions)) *ListInvestigationGroupsPaginator

NewListInvestigationGroupsPaginator returns a new ListInvestigationGroupsPaginator

func (*ListInvestigationGroupsPaginator) HasMorePages 

func (p *ListInvestigationGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListInvestigationGroupsPaginator) NextPage 

func (p *ListInvestigationGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListInvestigationGroupsOutput, error)

NextPage retrieves the next ListInvestigationGroups page.

type ListInvestigationGroupsPaginatorOptions 

type ListInvestigationGroupsPaginatorOptions struct {
	// The maximum number of results to return in one operation. If you omit this
	// parameter, the default of 50 is used.
	Limit int32

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

ListInvestigationGroupsPaginatorOptions is the paginator options for ListInvestigationGroups

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The ARN of the CloudWatch investigations resource that you want to view tags
	// for. You can use the [ListInvestigationGroups]operation to find the ARNs of investigation groups.
	//
	// The ARN format for an investigation group is
	// arn:aws:aiops:Region:account-id:investigation-group:investigation-group-id .
	//
	// [ListInvestigationGroups]: https://docs.aws.amazon.com/operationalinvestigations/latest/AmazonQDeveloperOperationalInvestigationsAPIReference/API_ListInvestigationGroups.html
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The list of tag keys and values associated with the resource you specified.
	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

	// Client registry of operation interceptors.
	Interceptors smithyhttp.InterceptorRegistry

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

type PutInvestigationGroupPolicyInput struct {

	// Specify either the name or the ARN of the investigation group that you want to
	// assign the policy to.
	//
	// This member is required.
	Identifier *string

	// The policy, in JSON format.
	//
	// This member is required.
	Policy *string
	// contains filtered or unexported fields
}

type PutInvestigationGroupPolicyOutput 

type PutInvestigationGroupPolicyOutput struct {

	// The ARN of the investigation group that will use this policy.
	InvestigationGroupArn *string

	// 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 (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource that you want to apply the tags
	// to. You can use the [ListInvestigationGroups]operation to find the ARNs of investigation groups.
	//
	// [ListInvestigationGroups]: https://docs.aws.amazon.com/operationalinvestigations/latest/AmazonQDeveloperOperationalInvestigationsAPIReference/API_ListInvestigationGroups.html
	//
	// This member is required.
	ResourceArn *string

	// The list of key-value pairs to associate with the resource.
	//
	// 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) of the resource that you want to remove the tags
	// from. You can use the [ListInvestigationGroups]operation to find the ARNs of investigation groups.
	//
	// [ListInvestigationGroups]: https://docs.aws.amazon.com/operationalinvestigations/latest/AmazonQDeveloperOperationalInvestigationsAPIReference/API_ListInvestigationGroups.html
	//
	// This member is required.
	ResourceArn *string

	// The list of tag keys to remove from the 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 UpdateInvestigationGroupInput 

type UpdateInvestigationGroupInput struct {

	// Specify either the name or the ARN of the investigation group that you want to
	// modify.
	//
	// This member is required.
	Identifier *string

	// Use this structure to integrate CloudWatch investigations with Amazon Q in chat
	// applications. This structure is a string array. For the first string, specify
	// the ARN of an Amazon SNS topic. For the array of strings, specify the ARNs of
	// one or more Amazon Q in chat applications configurations that you want to
	// associate with that topic. For more information about these configuration ARNs,
	// see [Getting started with Amazon Q in chat applications]and [Resource type defined by Amazon Web Services Chatbot].
	//
	// [Resource type defined by Amazon Web Services Chatbot]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awschatbot.html#awschatbot-resources-for-iam-policies
	// [Getting started with Amazon Q in chat applications]: https://docs.aws.amazon.com/chatbot/latest/adminguide/getting-started.html
	ChatbotNotificationChannel map[string][]string

	// Used to configure cross-account access for an investigation group. It allows
	// the investigation group to access resources in other accounts.
	CrossAccountConfigurations []types.CrossAccountConfiguration

	// Use this structure if you want to use a customer managed KMS key to encrypt
	// your investigation data. If you omit this parameter, CloudWatch investigations
	// will use an Amazon Web Services key to encrypt the data. For more information,
	// see [Encryption of investigation data].
	//
	// [Encryption of investigation data]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Investigations-Security.html#Investigations-KMS
	EncryptionConfiguration *types.EncryptionConfiguration

	// Specify true to enable CloudWatch investigations to have access to change
	// events that are recorded by CloudTrail. The default is true .
	IsCloudTrailEventHistoryEnabled *bool

	// Specify this field if you want to change the IAM role that CloudWatch
	// investigations will use when it gathers investigation data. To do so, specify
	// the ARN of the new role.
	//
	// The permissions in this role determine which of your resources that CloudWatch
	// investigations will have access to during investigations.
	//
	// For more information, see [EHow to control what data Amazon Q has access to during investigations].
	//
	// [EHow to control what data Amazon Q has access to during investigations]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Investigations-Security.html#Investigations-Security-Data
	RoleArn *string

	// Enter the existing custom tag keys for custom applications in your system.
	// Resource tags help Amazon Q narrow the search space when it is unable to
	// discover definite relationships between resources. For example, to discover that
	// an Amazon ECS service depends on an Amazon RDS database, Amazon Q can discover
	// this relationship using data sources such as X-Ray and CloudWatch Application
	// Signals. However, if you haven't deployed these features, Amazon Q will attempt
	// to identify possible relationships. Tag boundaries can be used to narrow the
	// resources that will be discovered by Amazon Q in these cases.
	//
	// You don't need to enter tags created by myApplications or CloudFormation,
	// because Amazon Q can automatically detect those tags.
	TagKeyBoundaries []string
	// contains filtered or unexported fields
}

type UpdateInvestigationGroupOutput 

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

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.