networkflowmonitor

package module
v1.9.1 Latest Latest
Warning

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

 Go to latest Published: Sep 23, 2025 License: Apache-2.0 Imports: 46 Imported by: 2

Documentation

Overview

Package networkflowmonitor provides the API client, operations, and parameter types for Network Flow Monitor.

Network Flow Monitor is a feature of Amazon CloudWatch Network Monitoring that provides visibility into the performance of network flows for your Amazon Web Services workloads, between instances in subnets, as well as to and from Amazon Web Services. Lightweight agents that you install on the instances capture performance metrics for your network flows, such as packet loss and latency, and send them to the Network Flow Monitor backend. Then, you can view and analyze metrics from the top contributors for each metric type, to help troubleshoot issues.

In addition, when you create a monitor, Network Flow Monitor provides a network health indicator (NHI) that informs you whether there were Amazon Web Services network issues for one or more of the network flows tracked by a monitor, during a time period that you choose. By using this value, you can independently determine if the Amazon Web Services network is impacting your workload during a specific time frame, to help you focus troubleshooting efforts.

To learn more about Network Flow Monitor, see the Network Flow Monitor User Guide in the Amazon CloudWatch User Guide.

Index

Constants

View Source 
const ServiceAPIVersion = "2023-04-19"
View Source 
const ServiceID = "NetworkFlowMonitor"

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 Network Flow Monitor.

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

func (c *Client) CreateMonitor(ctx context.Context, params *CreateMonitorInput, optFns ...func(*Options)) (*CreateMonitorOutput, error)

Create a monitor for specific network flows between local and remote resources, so that you can monitor network performance for one or several of your workloads. For each monitor, Network Flow Monitor publishes detailed end-to-end performance metrics and a network health indicator (NHI) that informs you whether there were Amazon Web Services network issues for one or more of the network flows tracked by a monitor, during a time period that you choose.

func (*Client) CreateScope 

func (c *Client) CreateScope(ctx context.Context, params *CreateScopeInput, optFns ...func(*Options)) (*CreateScopeOutput, error)

In Network Flow Monitor, you specify a scope for the service to generate metrics for. By using the scope, Network Flow Monitor can generate a topology of all the resources to measure performance metrics for. When you create a scope, you enable permissions for Network Flow Monitor.

A scope is a Region-account pair or multiple Region-account pairs. Network Flow Monitor uses your scope to determine all the resources (the topology) where Network Flow Monitor will gather network flow performance metrics for you. To provide performance metrics, Network Flow Monitor uses the data that is sent by the Network Flow Monitor agents you install on the resources.

To define the Region-account pairs for your scope, the Network Flow Monitor API uses the following constucts, which allow for future flexibility in defining scopes:

  • Targets, which are arrays of targetResources.

  • Target resources, which are Region-targetIdentifier pairs.

  • Target identifiers, made up of a targetID (currently always an account ID) and a targetType (currently always an account).

func (*Client) DeleteMonitor 

func (c *Client) DeleteMonitor(ctx context.Context, params *DeleteMonitorInput, optFns ...func(*Options)) (*DeleteMonitorOutput, error)

Deletes a monitor in Network Flow Monitor.

func (*Client) DeleteScope 

func (c *Client) DeleteScope(ctx context.Context, params *DeleteScopeInput, optFns ...func(*Options)) (*DeleteScopeOutput, error)

Deletes a scope that has been defined.

func (*Client) GetMonitor 

func (c *Client) GetMonitor(ctx context.Context, params *GetMonitorInput, optFns ...func(*Options)) (*GetMonitorOutput, error)

Gets information about a monitor in Network Flow Monitor based on a monitor name. The information returned includes the Amazon Resource Name (ARN), create time, modified time, resources included in the monitor, and status information.

func (*Client) GetQueryResultsMonitorTopContributors 

func (c *Client) GetQueryResultsMonitorTopContributors(ctx context.Context, params *GetQueryResultsMonitorTopContributorsInput, optFns ...func(*Options)) (*GetQueryResultsMonitorTopContributorsOutput, error)

Return the data for a query with the Network Flow Monitor query interface. You specify the query that you want to return results for by providing a query ID and a monitor name. This query returns the top contributors for a specific monitor.

Create a query ID for this call by calling the corresponding API call to start the query, StartQueryMonitorTopContributors . Use the scope ID that was returned for your account by CreateScope .

Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.

func (*Client) GetQueryResultsWorkloadInsightsTopContributors 

func (c *Client) GetQueryResultsWorkloadInsightsTopContributors(ctx context.Context, params *GetQueryResultsWorkloadInsightsTopContributorsInput, optFns ...func(*Options)) (*GetQueryResultsWorkloadInsightsTopContributorsOutput, error)

Return the data for a query with the Network Flow Monitor query interface. You specify the query that you want to return results for by providing a query ID and a monitor name.

This query returns the top contributors for a scope for workload insights. Workload insights provide a high level view of network flow performance data collected by agents. To return the data for the top contributors, see GetQueryResultsWorkloadInsightsTopContributorsData .

Create a query ID for this call by calling the corresponding API call to start the query, StartQueryWorkloadInsightsTopContributors . Use the scope ID that was returned for your account by CreateScope .

Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.

func (*Client) GetQueryResultsWorkloadInsightsTopContributorsData 

func (c *Client) GetQueryResultsWorkloadInsightsTopContributorsData(ctx context.Context, params *GetQueryResultsWorkloadInsightsTopContributorsDataInput, optFns ...func(*Options)) (*GetQueryResultsWorkloadInsightsTopContributorsDataOutput, error)

Return the data for a query with the Network Flow Monitor query interface. Specify the query that you want to return results for by providing a query ID and a scope ID.

This query returns the data for top contributors for workload insights for a specific scope. Workload insights provide a high level view of network flow performance data collected by agents for a scope. To return just the top contributors, see GetQueryResultsWorkloadInsightsTopContributors .

Create a query ID for this call by calling the corresponding API call to start the query, StartQueryWorkloadInsightsTopContributorsData . Use the scope ID that was returned for your account by CreateScope .

Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.

The top contributor network flows overall are for a specific metric type, for example, the number of retransmissions.

func (*Client) GetQueryStatusMonitorTopContributors 

func (c *Client) GetQueryStatusMonitorTopContributors(ctx context.Context, params *GetQueryStatusMonitorTopContributorsInput, optFns ...func(*Options)) (*GetQueryStatusMonitorTopContributorsOutput, error)

Returns the current status of a query for the Network Flow Monitor query interface, for a specified query ID and monitor. This call returns the query status for the top contributors for a monitor.

When you create a query, use this call to check the status of the query to make sure that it has has SUCCEEDED before you review the results. Use the same query ID that you used for the corresponding API call to start (create) the query, StartQueryMonitorTopContributors .

When you run a query, use this call to check the status of the query to make sure that the query has SUCCEEDED before you review the results.

func (*Client) GetQueryStatusWorkloadInsightsTopContributors 

func (c *Client) GetQueryStatusWorkloadInsightsTopContributors(ctx context.Context, params *GetQueryStatusWorkloadInsightsTopContributorsInput, optFns ...func(*Options)) (*GetQueryStatusWorkloadInsightsTopContributorsOutput, error)

Return the data for a query with the Network Flow Monitor query interface. Specify the query that you want to return results for by providing a query ID and a monitor name. This query returns the top contributors for workload insights.

When you start a query, use this call to check the status of the query to make sure that it has has SUCCEEDED before you review the results. Use the same query ID that you used for the corresponding API call to start the query, StartQueryWorkloadInsightsTopContributors .

Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.

func (*Client) GetQueryStatusWorkloadInsightsTopContributorsData 

func (c *Client) GetQueryStatusWorkloadInsightsTopContributorsData(ctx context.Context, params *GetQueryStatusWorkloadInsightsTopContributorsDataInput, optFns ...func(*Options)) (*GetQueryStatusWorkloadInsightsTopContributorsDataOutput, error)

Returns the current status of a query for the Network Flow Monitor query interface, for a specified query ID and monitor. This call returns the query status for the top contributors data for workload insights.

When you start a query, use this call to check the status of the query to make sure that it has has SUCCEEDED before you review the results. Use the same query ID that you used for the corresponding API call to start the query, StartQueryWorkloadInsightsTopContributorsData .

Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.

The top contributor network flows overall are for a specific metric type, for example, the number of retransmissions.

func (*Client) GetScope 

func (c *Client) GetScope(ctx context.Context, params *GetScopeInput, optFns ...func(*Options)) (*GetScopeOutput, error)

Gets information about a scope, including the name, status, tags, and target details. The scope in Network Flow Monitor is an account.

func (*Client) ListMonitors 

func (c *Client) ListMonitors(ctx context.Context, params *ListMonitorsInput, optFns ...func(*Options)) (*ListMonitorsOutput, error)

List all monitors in an account. Optionally, you can list only monitors that have a specific status, by using the STATUS parameter.

func (*Client) ListScopes 

func (c *Client) ListScopes(ctx context.Context, params *ListScopesInput, optFns ...func(*Options)) (*ListScopesOutput, error)

List all the scopes for an account.

func (*Client) ListTagsForResource 

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

Returns all the tags for a resource.

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

func (c *Client) StartQueryMonitorTopContributors(ctx context.Context, params *StartQueryMonitorTopContributorsInput, optFns ...func(*Options)) (*StartQueryMonitorTopContributorsOutput, error)

Create a query that you can use with the Network Flow Monitor query interface to return the top contributors for a monitor. Specify the monitor that you want to create the query for.

The call returns a query ID that you can use with GetQueryResultsMonitorTopContributors to run the query and return the top contributors for a specific monitor.

Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable APIs for the top contributors that you want to be returned.

func (*Client) StartQueryWorkloadInsightsTopContributors 

func (c *Client) StartQueryWorkloadInsightsTopContributors(ctx context.Context, params *StartQueryWorkloadInsightsTopContributorsInput, optFns ...func(*Options)) (*StartQueryWorkloadInsightsTopContributorsOutput, error)

Create a query with the Network Flow Monitor query interface that you can run to return workload insights top contributors. Specify the scope that you want to create a query for.

The call returns a query ID that you can use with GetQueryResultsWorkloadInsightsTopContributors to run the query and return the top contributors for the workload insights for a scope.

Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable APIs for the top contributors that you want to be returned.

func (*Client) StartQueryWorkloadInsightsTopContributorsData 

func (c *Client) StartQueryWorkloadInsightsTopContributorsData(ctx context.Context, params *StartQueryWorkloadInsightsTopContributorsDataInput, optFns ...func(*Options)) (*StartQueryWorkloadInsightsTopContributorsDataOutput, error)

Create a query with the Network Flow Monitor query interface that you can run to return data for workload insights top contributors. Specify the scope that you want to create a query for.

The call returns a query ID that you can use with GetQueryResultsWorkloadInsightsTopContributorsData to run the query and return the data for the top contributors for the workload insights for a scope.

Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.

func (*Client) StopQueryMonitorTopContributors 

func (c *Client) StopQueryMonitorTopContributors(ctx context.Context, params *StopQueryMonitorTopContributorsInput, optFns ...func(*Options)) (*StopQueryMonitorTopContributorsOutput, error)

Stop a top contributors query for a monitor. Specify the query that you want to stop by providing a query ID and a monitor name.

Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.

func (*Client) StopQueryWorkloadInsightsTopContributors 

func (c *Client) StopQueryWorkloadInsightsTopContributors(ctx context.Context, params *StopQueryWorkloadInsightsTopContributorsInput, optFns ...func(*Options)) (*StopQueryWorkloadInsightsTopContributorsOutput, error)

Stop a top contributors query for workload insights. Specify the query that you want to stop by providing a query ID and a scope ID.

Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.

func (*Client) StopQueryWorkloadInsightsTopContributorsData 

func (c *Client) StopQueryWorkloadInsightsTopContributorsData(ctx context.Context, params *StopQueryWorkloadInsightsTopContributorsDataInput, optFns ...func(*Options)) (*StopQueryWorkloadInsightsTopContributorsDataOutput, error)

Stop a top contributors data query for workload insights. Specify the query that you want to stop by providing a query ID and a scope ID.

Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.

func (*Client) TagResource 

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

Adds a tag to a resource.

func (*Client) UntagResource 

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

Removes a tag from a resource.

func (*Client) UpdateMonitor 

func (c *Client) UpdateMonitor(ctx context.Context, params *UpdateMonitorInput, optFns ...func(*Options)) (*UpdateMonitorOutput, error)

Update a monitor to add or remove local or remote resources.

func (*Client) UpdateScope 

func (c *Client) UpdateScope(ctx context.Context, params *UpdateScopeInput, optFns ...func(*Options)) (*UpdateScopeOutput, error)

Update a scope to add or remove resources that you want to be available for Network Flow Monitor to generate metrics for, when you have active agents on those resources sending metrics reports to the Network Flow Monitor backend.

type CreateMonitorInput 

type CreateMonitorInput struct {

	// The local resources to monitor. A local resource in a workload is the location
	// of the host, or hosts, where the Network Flow Monitor agent is installed. For
	// example, if a workload consists of an interaction between a web service and a
	// backend database (for example, Amazon Dynamo DB), the subnet with the EC2
	// instance that hosts the web service, which also runs the agent, is the local
	// resource.
	//
	// Be aware that all local resources must belong to the current Region.
	//
	// This member is required.
	LocalResources []types.MonitorLocalResource

	// The name of the monitor.
	//
	// This member is required.
	MonitorName *string

	// The Amazon Resource Name (ARN) of the scope for the monitor.
	//
	// This member is required.
	ScopeArn *string

	// A unique, case-sensitive string of up to 64 ASCII characters that you specify
	// to make an idempotent API request. Don't reuse the same client token for other
	// API requests.
	ClientToken *string

	// The remote resources to monitor. A remote resource is the other endpoint in the
	// bi-directional flow of a workload, with a local resource. For example, Amazon
	// Dynamo DB can be a remote resource.
	//
	// When you specify remote resources, be aware that specific combinations of
	// resources are allowed and others are not, including the following constraints:
	//
	//   - All remote resources that you specify must all belong to a single Region.
	//
	//   - If you specify Amazon Web Services services as remote resources, any other
	//   remote resources that you specify must be in the current Region.
	//
	//   - When you specify a remote resource for another Region, you can only specify
	//   the Region resource type. You cannot specify a subnet, VPC, or Availability
	//   Zone in another Region.
	//
	//   - If you leave the RemoteResources parameter empty, the monitor will include
	//   all network flows that terminate in the current Region.
	RemoteResources []types.MonitorRemoteResource

	// The tags for a monitor. You can add a maximum of 200 tags.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateMonitorOutput 

type CreateMonitorOutput struct {

	// The date and time when the monitor was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The local resources to monitor. A local resource in a workload is the location
	// of hosts where the Network Flow Monitor agent is installed.
	//
	// This member is required.
	LocalResources []types.MonitorLocalResource

	// The last date and time that the monitor was modified.
	//
	// This member is required.
	ModifiedAt *time.Time

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

	// The name of the monitor.
	//
	// This member is required.
	MonitorName *string

	// The status of a monitor. The status can be one of the following
	//
	//   - PENDING : The monitor is in the process of being created.
	//
	//   - ACTIVE : The monitor is active.
	//
	//   - INACTIVE : The monitor is inactive.
	//
	//   - ERROR : Monitor creation failed due to an error.
	//
	//   - DELETING : The monitor is in the process of being deleted.
	//
	// This member is required.
	MonitorStatus types.MonitorStatus

	// The remote resources to monitor. A remote resource is the other endpoint
	// specified for the network flow of a workload, with a local resource. For
	// example, Amazon Dynamo DB can be a remote resource.
	//
	// This member is required.
	RemoteResources []types.MonitorRemoteResource

	// The tags for a monitor.
	Tags map[string]string

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

type CreateScopeInput 

type CreateScopeInput struct {

	// The targets to define the scope to be monitored. A target is an array of
	// targetResources, which are currently Region-account pairs, defined by
	// targetResource constructs.
	//
	// This member is required.
	Targets []types.TargetResource

	// A unique, case-sensitive string of up to 64 ASCII characters that you specify
	// to make an idempotent API request. Don't reuse the same client token for other
	// API requests.
	ClientToken *string

	// The tags for a scope. You can add a maximum of 200 tags.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateScopeOutput 

type CreateScopeOutput struct {

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

	// The identifier for the scope that includes the resources you want to get
	// metrics for. A scope ID is an internally-generated identifier that includes all
	// the resources for a specific root account.
	//
	// This member is required.
	ScopeId *string

	// The status for a scope. The status can be one of the following: SUCCEEDED ,
	// IN_PROGRESS , FAILED , DEACTIVATING , or DEACTIVATED .
	//
	// A status of DEACTIVATING means that you've requested a scope to be deactivated
	// and Network Flow Monitor is in the process of deactivating the scope. A status
	// of DEACTIVATED means that the deactivating process is complete.
	//
	// This member is required.
	Status types.ScopeStatus

	// The tags for a scope.
	Tags map[string]string

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

type DeleteMonitorInput 

type DeleteMonitorInput struct {

	// The name of the monitor to delete.
	//
	// This member is required.
	MonitorName *string
	// contains filtered or unexported fields
}

type DeleteMonitorOutput 

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

type DeleteScopeInput 

type DeleteScopeInput struct {

	// The identifier for the scope that includes the resources you want to get data
	// results for. A scope ID is an internally-generated identifier that includes all
	// the resources for a specific root account.
	//
	// This member is required.
	ScopeId *string
	// contains filtered or unexported fields
}

type DeleteScopeOutput 

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

type EndpointParameters 

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

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

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

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetMonitorInput 

type GetMonitorInput struct {

	// The name of the monitor.
	//
	// This member is required.
	MonitorName *string
	// contains filtered or unexported fields
}

type GetMonitorOutput 

type GetMonitorOutput struct {

	// The date and time when the monitor was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The local resources to monitor. A local resource in a workload is the location
	// of the hosts where the Network Flow Monitor agent is installed.
	//
	// This member is required.
	LocalResources []types.MonitorLocalResource

	// The date and time when the monitor was last modified.
	//
	// This member is required.
	ModifiedAt *time.Time

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

	// The name of the monitor.
	//
	// This member is required.
	MonitorName *string

	// The status of a monitor. The status can be one of the following
	//
	//   - PENDING : The monitor is in the process of being created.
	//
	//   - ACTIVE : The monitor is active.
	//
	//   - INACTIVE : The monitor is inactive.
	//
	//   - ERROR : Monitor creation failed due to an error.
	//
	//   - DELETING : The monitor is in the process of being deleted.
	//
	// This member is required.
	MonitorStatus types.MonitorStatus

	// The remote resources to monitor. A remote resource is the other endpoint
	// specified for the network flow of a workload, with a local resource. For
	// example, Amazon Dynamo DB can be a remote resource.
	//
	// This member is required.
	RemoteResources []types.MonitorRemoteResource

	// The tags for a monitor.
	Tags map[string]string

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

type GetQueryResultsMonitorTopContributorsAPIClient 

type GetQueryResultsMonitorTopContributorsAPIClient interface {
	GetQueryResultsMonitorTopContributors(context.Context, *GetQueryResultsMonitorTopContributorsInput, ...func(*Options)) (*GetQueryResultsMonitorTopContributorsOutput, error)
}

GetQueryResultsMonitorTopContributorsAPIClient is a client that implements the GetQueryResultsMonitorTopContributors operation.

type GetQueryResultsMonitorTopContributorsInput 

type GetQueryResultsMonitorTopContributorsInput struct {

	// The name of the monitor.
	//
	// This member is required.
	MonitorName *string

	// The identifier for the query. A query ID is an internally-generated identifier
	// for a specific query returned from an API call to create a query.
	//
	// This member is required.
	QueryId *string

	// The number of query results that you want to return with this call.
	MaxResults *int32

	// The token for the next set of results. You receive this token from a previous
	// call.
	NextToken *string
	// contains filtered or unexported fields
}

type GetQueryResultsMonitorTopContributorsOutput 

type GetQueryResultsMonitorTopContributorsOutput struct {

	// The token for the next set of results. You receive this token from a previous
	// call.
	NextToken *string

	// The top contributor network flows overall for a specific metric type, for
	// example, the number of retransmissions.
	TopContributors []types.MonitorTopContributorsRow

	// The units for a metric returned by the query.
	Unit types.MetricUnit

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

type GetQueryResultsMonitorTopContributorsPaginator 

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

GetQueryResultsMonitorTopContributorsPaginator is a paginator for GetQueryResultsMonitorTopContributors

func NewGetQueryResultsMonitorTopContributorsPaginator 

func NewGetQueryResultsMonitorTopContributorsPaginator(client GetQueryResultsMonitorTopContributorsAPIClient, params *GetQueryResultsMonitorTopContributorsInput, optFns ...func(*GetQueryResultsMonitorTopContributorsPaginatorOptions)) *GetQueryResultsMonitorTopContributorsPaginator

NewGetQueryResultsMonitorTopContributorsPaginator returns a new GetQueryResultsMonitorTopContributorsPaginator

func (*GetQueryResultsMonitorTopContributorsPaginator) HasMorePages 

func (p *GetQueryResultsMonitorTopContributorsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetQueryResultsMonitorTopContributorsPaginator) NextPage 

func (p *GetQueryResultsMonitorTopContributorsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetQueryResultsMonitorTopContributorsOutput, error)

NextPage retrieves the next GetQueryResultsMonitorTopContributors page.

type GetQueryResultsMonitorTopContributorsPaginatorOptions 

type GetQueryResultsMonitorTopContributorsPaginatorOptions struct {
	// The number of query results that you want to return with this call.
	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
}

GetQueryResultsMonitorTopContributorsPaginatorOptions is the paginator options for GetQueryResultsMonitorTopContributors

type GetQueryResultsWorkloadInsightsTopContributorsAPIClient 

type GetQueryResultsWorkloadInsightsTopContributorsAPIClient interface {
	GetQueryResultsWorkloadInsightsTopContributors(context.Context, *GetQueryResultsWorkloadInsightsTopContributorsInput, ...func(*Options)) (*GetQueryResultsWorkloadInsightsTopContributorsOutput, error)
}

GetQueryResultsWorkloadInsightsTopContributorsAPIClient is a client that implements the GetQueryResultsWorkloadInsightsTopContributors operation.

type GetQueryResultsWorkloadInsightsTopContributorsDataAPIClient 

type GetQueryResultsWorkloadInsightsTopContributorsDataAPIClient interface {
	GetQueryResultsWorkloadInsightsTopContributorsData(context.Context, *GetQueryResultsWorkloadInsightsTopContributorsDataInput, ...func(*Options)) (*GetQueryResultsWorkloadInsightsTopContributorsDataOutput, error)
}

GetQueryResultsWorkloadInsightsTopContributorsDataAPIClient is a client that implements the GetQueryResultsWorkloadInsightsTopContributorsData operation.

type GetQueryResultsWorkloadInsightsTopContributorsDataInput 

type GetQueryResultsWorkloadInsightsTopContributorsDataInput struct {

	// The identifier for the query. A query ID is an internally-generated identifier
	// for a specific query returned from an API call to create a query.
	//
	// This member is required.
	QueryId *string

	// The identifier for the scope that includes the resources you want to get data
	// results for. A scope ID is an internally-generated identifier that includes all
	// the resources for a specific root account.
	//
	// This member is required.
	ScopeId *string

	// The number of query results that you want to return with this call.
	MaxResults *int32

	// The token for the next set of results. You receive this token from a previous
	// call.
	NextToken *string
	// contains filtered or unexported fields
}

type GetQueryResultsWorkloadInsightsTopContributorsDataOutput 

type GetQueryResultsWorkloadInsightsTopContributorsDataOutput struct {

	// The datapoints returned by the query.
	//
	// This member is required.
	Datapoints []types.WorkloadInsightsTopContributorsDataPoint

	// The units for a metric returned by the query.
	//
	// This member is required.
	Unit types.MetricUnit

	// The token for the next set of results. You receive this token from a previous
	// call.
	NextToken *string

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

type GetQueryResultsWorkloadInsightsTopContributorsDataPaginator 

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

GetQueryResultsWorkloadInsightsTopContributorsDataPaginator is a paginator for GetQueryResultsWorkloadInsightsTopContributorsData

func NewGetQueryResultsWorkloadInsightsTopContributorsDataPaginator 

func NewGetQueryResultsWorkloadInsightsTopContributorsDataPaginator(client GetQueryResultsWorkloadInsightsTopContributorsDataAPIClient, params *GetQueryResultsWorkloadInsightsTopContributorsDataInput, optFns ...func(*GetQueryResultsWorkloadInsightsTopContributorsDataPaginatorOptions)) *GetQueryResultsWorkloadInsightsTopContributorsDataPaginator

NewGetQueryResultsWorkloadInsightsTopContributorsDataPaginator returns a new GetQueryResultsWorkloadInsightsTopContributorsDataPaginator

func (*GetQueryResultsWorkloadInsightsTopContributorsDataPaginator) HasMorePages 

func (p *GetQueryResultsWorkloadInsightsTopContributorsDataPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetQueryResultsWorkloadInsightsTopContributorsDataPaginator) NextPage 

func (p *GetQueryResultsWorkloadInsightsTopContributorsDataPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetQueryResultsWorkloadInsightsTopContributorsDataOutput, error)

NextPage retrieves the next GetQueryResultsWorkloadInsightsTopContributorsData page.

type GetQueryResultsWorkloadInsightsTopContributorsDataPaginatorOptions 

type GetQueryResultsWorkloadInsightsTopContributorsDataPaginatorOptions struct {
	// The number of query results that you want to return with this call.
	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
}

GetQueryResultsWorkloadInsightsTopContributorsDataPaginatorOptions is the paginator options for GetQueryResultsWorkloadInsightsTopContributorsData

type GetQueryResultsWorkloadInsightsTopContributorsInput 

type GetQueryResultsWorkloadInsightsTopContributorsInput struct {

	// The identifier for the query. A query ID is an internally-generated identifier
	// for a specific query returned from an API call to create a query.
	//
	// This member is required.
	QueryId *string

	// The identifier for the scope that includes the resources you want to get data
	// results for. A scope ID is an internally-generated identifier that includes all
	// the resources for a specific root account.
	//
	// This member is required.
	ScopeId *string

	// The number of query results that you want to return with this call.
	MaxResults *int32

	// The token for the next set of results. You receive this token from a previous
	// call.
	NextToken *string
	// contains filtered or unexported fields
}

type GetQueryResultsWorkloadInsightsTopContributorsOutput 

type GetQueryResultsWorkloadInsightsTopContributorsOutput struct {

	// The token for the next set of results. You receive this token from a previous
	// call.
	NextToken *string

	// The top contributor network flows overall for a specific metric type, for
	// example, the number of retransmissions.
	TopContributors []types.WorkloadInsightsTopContributorsRow

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

type GetQueryResultsWorkloadInsightsTopContributorsPaginator 

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

GetQueryResultsWorkloadInsightsTopContributorsPaginator is a paginator for GetQueryResultsWorkloadInsightsTopContributors

func NewGetQueryResultsWorkloadInsightsTopContributorsPaginator 

func NewGetQueryResultsWorkloadInsightsTopContributorsPaginator(client GetQueryResultsWorkloadInsightsTopContributorsAPIClient, params *GetQueryResultsWorkloadInsightsTopContributorsInput, optFns ...func(*GetQueryResultsWorkloadInsightsTopContributorsPaginatorOptions)) *GetQueryResultsWorkloadInsightsTopContributorsPaginator

NewGetQueryResultsWorkloadInsightsTopContributorsPaginator returns a new GetQueryResultsWorkloadInsightsTopContributorsPaginator

func (*GetQueryResultsWorkloadInsightsTopContributorsPaginator) HasMorePages 

func (p *GetQueryResultsWorkloadInsightsTopContributorsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetQueryResultsWorkloadInsightsTopContributorsPaginator) NextPage 

func (p *GetQueryResultsWorkloadInsightsTopContributorsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetQueryResultsWorkloadInsightsTopContributorsOutput, error)

NextPage retrieves the next GetQueryResultsWorkloadInsightsTopContributors page.

type GetQueryResultsWorkloadInsightsTopContributorsPaginatorOptions 

type GetQueryResultsWorkloadInsightsTopContributorsPaginatorOptions struct {
	// The number of query results that you want to return with this call.
	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
}

GetQueryResultsWorkloadInsightsTopContributorsPaginatorOptions is the paginator options for GetQueryResultsWorkloadInsightsTopContributors

type GetQueryStatusMonitorTopContributorsInput 

type GetQueryStatusMonitorTopContributorsInput struct {

	// The name of the monitor.
	//
	// This member is required.
	MonitorName *string

	// The identifier for the query. A query ID is an internally-generated identifier
	// for a specific query returned from an API call to start a query.
	//
	// This member is required.
	QueryId *string
	// contains filtered or unexported fields
}

type GetQueryStatusMonitorTopContributorsOutput 

type GetQueryStatusMonitorTopContributorsOutput struct {

	// When you run a query, use this call to check the status of the query to make
	// sure that the query has SUCCEEDED before you review the results.
	//
	//   - QUEUED : The query is scheduled to run.
	//
	//   - RUNNING : The query is in progress but not complete.
	//
	//   - SUCCEEDED : The query completed sucessfully.
	//
	//   - FAILED : The query failed due to an error.
	//
	//   - CANCELED : The query was canceled.
	//
	// This member is required.
	Status types.QueryStatus

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

type GetQueryStatusWorkloadInsightsTopContributorsDataInput 

type GetQueryStatusWorkloadInsightsTopContributorsDataInput struct {

	// The identifier for the query. A query ID is an internally-generated identifier
	// for a specific query returned from an API call to start a query.
	//
	// This member is required.
	QueryId *string

	// The identifier for the scope that includes the resources you want to get data
	// results for. A scope ID is an internally-generated identifier that includes all
	// the resources for a specific root account. A scope ID is returned from a
	// CreateScope API call.
	//
	// This member is required.
	ScopeId *string
	// contains filtered or unexported fields
}

type GetQueryStatusWorkloadInsightsTopContributorsDataOutput 

type GetQueryStatusWorkloadInsightsTopContributorsDataOutput struct {

	// The status of a query for top contributors data.
	//
	//   - QUEUED : The query is scheduled to run.
	//
	//   - RUNNING : The query is in progress but not complete.
	//
	//   - SUCCEEDED : The query completed sucessfully.
	//
	//   - FAILED : The query failed due to an error.
	//
	//   - CANCELED : The query was canceled.
	//
	// This member is required.
	Status types.QueryStatus

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

type GetQueryStatusWorkloadInsightsTopContributorsInput 

type GetQueryStatusWorkloadInsightsTopContributorsInput struct {

	// The identifier for the query. A query ID is an internally-generated identifier
	// for a specific query returned from an API call to start a query.
	//
	// This member is required.
	QueryId *string

	// The identifier for the scope that includes the resources you want to get data
	// results for. A scope ID is an internally-generated identifier that includes all
	// the resources for a specific root account.
	//
	// This member is required.
	ScopeId *string
	// contains filtered or unexported fields
}

type GetQueryStatusWorkloadInsightsTopContributorsOutput 

type GetQueryStatusWorkloadInsightsTopContributorsOutput struct {

	// When you run a query, use this call to check the status of the query to make
	// sure that the query has SUCCEEDED before you review the results.
	//
	//   - QUEUED : The query is scheduled to run.
	//
	//   - RUNNING : The query is in progress but not complete.
	//
	//   - SUCCEEDED : The query completed sucessfully.
	//
	//   - FAILED : The query failed due to an error.
	//
	//   - CANCELED : The query was canceled.
	//
	// This member is required.
	Status types.QueryStatus

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

type GetScopeInput 

type GetScopeInput struct {

	// The identifier for the scope that includes the resources you want to get data
	// results for. A scope ID is an internally-generated identifier that includes all
	// the resources for a specific root account. A scope ID is returned from a
	// CreateScope API call.
	//
	// This member is required.
	ScopeId *string
	// contains filtered or unexported fields
}

type GetScopeOutput 

type GetScopeOutput struct {

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

	// The identifier for the scope that includes the resources you want to get data
	// results for. A scope ID is an internally-generated identifier that includes all
	// the resources for a specific root account. A scope ID is returned from a
	// CreateScope API call.
	//
	// This member is required.
	ScopeId *string

	// The status for a scope. The status can be one of the following: SUCCEEDED ,
	// IN_PROGRESS , FAILED , DEACTIVATING , or DEACTIVATED .
	//
	// A status of DEACTIVATING means that you've requested a scope to be deactivated
	// and Network Flow Monitor is in the process of deactivating the scope. A status
	// of DEACTIVATED means that the deactivating process is complete.
	//
	// This member is required.
	Status types.ScopeStatus

	// The targets to define the scope to be monitored. A target is an array of
	// targetResources, which are currently Region-account pairs, defined by
	// targetResource constructs.
	//
	// This member is required.
	Targets []types.TargetResource

	// The tags for a scope.
	Tags map[string]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 IdempotencyTokenProvider 

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

IdempotencyTokenProvider interface for providing idempotency token

type ListMonitorsAPIClient 

type ListMonitorsAPIClient interface {
	ListMonitors(context.Context, *ListMonitorsInput, ...func(*Options)) (*ListMonitorsOutput, error)
}

ListMonitorsAPIClient is a client that implements the ListMonitors operation.

type ListMonitorsInput 

type ListMonitorsInput struct {

	// The number of query results that you want to return with this call.
	MaxResults *int32

	// The status of a monitor. The status can be one of the following
	//
	//   - PENDING : The monitor is in the process of being created.
	//
	//   - ACTIVE : The monitor is active.
	//
	//   - INACTIVE : The monitor is inactive.
	//
	//   - ERROR : Monitor creation failed due to an error.
	//
	//   - DELETING : The monitor is in the process of being deleted.
	MonitorStatus types.MonitorStatus

	// The token for the next set of results. You receive this token from a previous
	// call.
	NextToken *string
	// contains filtered or unexported fields
}

type ListMonitorsOutput 

type ListMonitorsOutput struct {

	// The monitors that are in an account.
	//
	// This member is required.
	Monitors []types.MonitorSummary

	// The token for the next set of results. You receive this token from a previous
	// call.
	NextToken *string

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

type ListMonitorsPaginator 

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

ListMonitorsPaginator is a paginator for ListMonitors

func NewListMonitorsPaginator 

func NewListMonitorsPaginator(client ListMonitorsAPIClient, params *ListMonitorsInput, optFns ...func(*ListMonitorsPaginatorOptions)) *ListMonitorsPaginator

NewListMonitorsPaginator returns a new ListMonitorsPaginator

func (*ListMonitorsPaginator) HasMorePages 

func (p *ListMonitorsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMonitorsPaginator) NextPage 

func (p *ListMonitorsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMonitorsOutput, error)

NextPage retrieves the next ListMonitors page.

type ListMonitorsPaginatorOptions 

type ListMonitorsPaginatorOptions struct {
	// The number of query results that you want to return with this call.
	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
}

ListMonitorsPaginatorOptions is the paginator options for ListMonitors

type ListScopesAPIClient 

type ListScopesAPIClient interface {
	ListScopes(context.Context, *ListScopesInput, ...func(*Options)) (*ListScopesOutput, error)
}

ListScopesAPIClient is a client that implements the ListScopes operation.

type ListScopesInput 

type ListScopesInput struct {

	// The number of query results that you want to return with this call.
	MaxResults *int32

	// The token for the next set of results. You receive this token from a previous
	// call.
	NextToken *string
	// contains filtered or unexported fields
}

type ListScopesOutput 

type ListScopesOutput struct {

	// The scopes returned by the call.
	//
	// This member is required.
	Scopes []types.ScopeSummary

	// The token for the next set of results. You receive this token from a previous
	// call.
	NextToken *string

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

type ListScopesPaginator 

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

ListScopesPaginator is a paginator for ListScopes

func NewListScopesPaginator 

func NewListScopesPaginator(client ListScopesAPIClient, params *ListScopesInput, optFns ...func(*ListScopesPaginatorOptions)) *ListScopesPaginator

NewListScopesPaginator returns a new ListScopesPaginator

func (*ListScopesPaginator) HasMorePages 

func (p *ListScopesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListScopesPaginator) NextPage 

func (p *ListScopesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListScopesOutput, error)

NextPage retrieves the next ListScopes page.

type ListScopesPaginatorOptions 

type ListScopesPaginatorOptions struct {
	// The number of query results that you want to return with this call.
	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
}

ListScopesPaginatorOptions is the paginator options for ListScopes

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The tags for a resource.
	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

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

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

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

	// Priority list of preferred auth scheme names (e.g. sigv4a).
	AuthSchemePreference []string
	// 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 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 StartQueryMonitorTopContributorsInput 

type StartQueryMonitorTopContributorsInput struct {

	// The category that you want to query top contributors for, for a specific
	// monitor. Destination categories can be one of the following:
	//
	//   - INTRA_AZ : Top contributor network flows within a single Availability Zone
	//
	//   - INTER_AZ : Top contributor network flows between Availability Zones
	//
	//   - INTER_REGION : Top contributor network flows between Regions (to the edge of
	//   another Region)
	//
	//   - INTER_VPC : Top contributor network flows between VPCs
	//
	//   - AMAZON_S3 : Top contributor network flows to or from Amazon S3
	//
	//   - AMAZON_DYNAMODB : Top contributor network flows to or from Amazon Dynamo DB
	//
	//   - UNCLASSIFIED : Top contributor network flows that do not have a bucket
	//   classification
	//
	// This member is required.
	DestinationCategory types.DestinationCategory

	// The timestamp that is the date and time end of the period that you want to
	// retrieve results for with your query.
	//
	// This member is required.
	EndTime *time.Time

	// The metric that you want to query top contributors for. That is, you can
	// specify a metric with this call and return the top contributor network flows,
	// for that type of metric, for a monitor and (optionally) within a specific
	// category, such as network flows between Availability Zones.
	//
	// This member is required.
	MetricName types.MonitorMetric

	// The name of the monitor.
	//
	// This member is required.
	MonitorName *string

	// The timestamp that is the date and time that is the beginning of the period
	// that you want to retrieve results for with your query.
	//
	// This member is required.
	StartTime *time.Time

	// The maximum number of top contributors to return.
	Limit *int32
	// contains filtered or unexported fields
}

type StartQueryMonitorTopContributorsOutput 

type StartQueryMonitorTopContributorsOutput struct {

	// The identifier for the query. A query ID is an internally-generated identifier
	// for a specific query returned from an API call to start a query.
	//
	// This member is required.
	QueryId *string

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

type StartQueryWorkloadInsightsTopContributorsDataInput 

type StartQueryWorkloadInsightsTopContributorsDataInput struct {

	// The destination category for a top contributors. Destination categories can be
	// one of the following:
	//
	//   - INTRA_AZ : Top contributor network flows within a single Availability Zone
	//
	//   - INTER_AZ : Top contributor network flows between Availability Zones
	//
	//   - INTER_REGION : Top contributor network flows between Regions (to the edge of
	//   another Region)
	//
	//   - INTER_VPC : Top contributor network flows between VPCs
	//
	//   - AWS_SERVICES : Top contributor network flows to or from Amazon Web Services
	//   services
	//
	//   - UNCLASSIFIED : Top contributor network flows that do not have a bucket
	//   classification
	//
	// This member is required.
	DestinationCategory types.DestinationCategory

	// The timestamp that is the date and time end of the period that you want to
	// retrieve results for with your query.
	//
	// This member is required.
	EndTime *time.Time

	// The metric that you want to query top contributors for. That is, you can
	// specify this metric to return the top contributor network flows, for this type
	// of metric, for a monitor and (optionally) within a specific category, such as
	// network flows between Availability Zones.
	//
	// This member is required.
	MetricName types.WorkloadInsightsMetric

	// The identifier for the scope that includes the resources you want to get data
	// results for. A scope ID is an internally-generated identifier that includes all
	// the resources for a specific root account.
	//
	// This member is required.
	ScopeId *string

	// The timestamp that is the date and time that is the beginning of the period
	// that you want to retrieve results for with your query.
	//
	// This member is required.
	StartTime *time.Time
	// contains filtered or unexported fields
}

type StartQueryWorkloadInsightsTopContributorsDataOutput 

type StartQueryWorkloadInsightsTopContributorsDataOutput struct {

	// The identifier for the query. A query ID is an internally-generated identifier
	// for a specific query returned from an API call to start a query.
	//
	// This member is required.
	QueryId *string

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

type StartQueryWorkloadInsightsTopContributorsInput 

type StartQueryWorkloadInsightsTopContributorsInput struct {

	// The destination category for a top contributors row. Destination categories can
	// be one of the following:
	//
	//   - INTRA_AZ : Top contributor network flows within a single Availability Zone
	//
	//   - INTER_AZ : Top contributor network flows between Availability Zones
	//
	//   - INTER_REGION : Top contributor network flows between Regions (to the edge of
	//   another Region)
	//
	//   - INTER_VPC : Top contributor network flows between VPCs
	//
	//   - AWS_SERVICES : Top contributor network flows to or from Amazon Web Services
	//   services
	//
	//   - UNCLASSIFIED : Top contributor network flows that do not have a bucket
	//   classification
	//
	// This member is required.
	DestinationCategory types.DestinationCategory

	// The timestamp that is the date and time end of the period that you want to
	// retrieve results for with your query.
	//
	// This member is required.
	EndTime *time.Time

	// The metric that you want to query top contributors for. That is, you can
	// specify this metric to return the top contributor network flows, for this type
	// of metric, for a monitor and (optionally) within a specific category, such as
	// network flows between Availability Zones.
	//
	// This member is required.
	MetricName types.WorkloadInsightsMetric

	// The identifier for the scope that includes the resources you want to get data
	// results for. A scope ID is an internally-generated identifier that includes all
	// the resources for a specific root account. A scope ID is returned from a
	// CreateScope API call.
	//
	// This member is required.
	ScopeId *string

	// The timestamp that is the date and time that is the beginning of the period
	// that you want to retrieve results for with your query.
	//
	// This member is required.
	StartTime *time.Time

	// The maximum number of top contributors to return.
	Limit *int32
	// contains filtered or unexported fields
}

type StartQueryWorkloadInsightsTopContributorsOutput 

type StartQueryWorkloadInsightsTopContributorsOutput struct {

	// The identifier for the query. A query ID is an internally-generated identifier
	// for a specific query returned from an API call to start a query.
	//
	// This member is required.
	QueryId *string

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

type StopQueryMonitorTopContributorsInput 

type StopQueryMonitorTopContributorsInput struct {

	// The name of the monitor.
	//
	// This member is required.
	MonitorName *string

	// The identifier for the query. A query ID is an internally-generated identifier
	// for a specific query returned from an API call to create a query.
	//
	// This member is required.
	QueryId *string
	// contains filtered or unexported fields
}

type StopQueryMonitorTopContributorsOutput 

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

type StopQueryWorkloadInsightsTopContributorsDataInput 

type StopQueryWorkloadInsightsTopContributorsDataInput struct {

	// The identifier for the query. A query ID is an internally-generated identifier
	// for a specific query returned from an API call to create a query.
	//
	// This member is required.
	QueryId *string

	// The identifier for the scope that includes the resources you want to get data
	// results for. A scope ID is an internally-generated identifier that includes all
	// the resources for a specific root account.
	//
	// This member is required.
	ScopeId *string
	// contains filtered or unexported fields
}

type StopQueryWorkloadInsightsTopContributorsDataOutput 

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

type StopQueryWorkloadInsightsTopContributorsInput 

type StopQueryWorkloadInsightsTopContributorsInput struct {

	// The identifier for the query. A query ID is an internally-generated identifier
	// for a specific query returned from an API call to create a query.
	//
	// This member is required.
	QueryId *string

	// The identifier for the scope that includes the resources you want to get data
	// results for. A scope ID is an internally-generated identifier that includes all
	// the resources for a specific root account.
	//
	// This member is required.
	ScopeId *string
	// contains filtered or unexported fields
}

type StopQueryWorkloadInsightsTopContributorsOutput 

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

type TagResourceInput 

type TagResourceInput struct {

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

	// The tags for a 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.
	//
	// This member is required.
	ResourceArn *string

	// Keys that you specified when you tagged a resource.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

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

type UpdateMonitorInput 

type UpdateMonitorInput struct {

	// The name of the monitor.
	//
	// This member is required.
	MonitorName *string

	// A unique, case-sensitive string of up to 64 ASCII characters that you specify
	// to make an idempotent API request. Don't reuse the same client token for other
	// API requests.
	ClientToken *string

	// Additional local resources to specify network flows for a monitor, as an array
	// of resources with identifiers and types. A local resource in a workload is the
	// location of hosts where the Network Flow Monitor agent is installed.
	LocalResourcesToAdd []types.MonitorLocalResource

	// The local resources to remove, as an array of resources with identifiers and
	// types.
	LocalResourcesToRemove []types.MonitorLocalResource

	// The remote resources to add, as an array of resources with identifiers and
	// types.
	//
	// A remote resource is the other endpoint in the flow of a workload, with a local
	// resource. For example, Amazon Dynamo DB can be a remote resource.
	RemoteResourcesToAdd []types.MonitorRemoteResource

	// The remote resources to remove, as an array of resources with identifiers and
	// types.
	//
	// A remote resource is the other endpoint specified for the network flow of a
	// workload, with a local resource. For example, Amazon Dynamo DB can be a remote
	// resource.
	RemoteResourcesToRemove []types.MonitorRemoteResource
	// contains filtered or unexported fields
}

type UpdateMonitorOutput 

type UpdateMonitorOutput struct {

	// The date and time when the monitor was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The local resources to monitor. A local resource in a workload is the location
	// of hosts where the Network Flow Monitor agent is installed.
	//
	// This member is required.
	LocalResources []types.MonitorLocalResource

	// The last date and time that the monitor was modified.
	//
	// This member is required.
	ModifiedAt *time.Time

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

	// The name of the monitor.
	//
	// This member is required.
	MonitorName *string

	// The status of a monitor. The status can be one of the following
	//
	//   - PENDING : The monitor is in the process of being created.
	//
	//   - ACTIVE : The monitor is active.
	//
	//   - INACTIVE : The monitor is inactive.
	//
	//   - ERROR : Monitor creation failed due to an error.
	//
	//   - DELETING : The monitor is in the process of being deleted.
	//
	// This member is required.
	MonitorStatus types.MonitorStatus

	// The remote resources updated for a monitor, as an array of resources with
	// identifiers and types.
	//
	// A remote resource is the other endpoint specified for the network flow of a
	// workload, with a local resource. For example, Amazon Dynamo DB can be a remote
	// resource.
	//
	// This member is required.
	RemoteResources []types.MonitorRemoteResource

	// The tags for a monitor.
	Tags map[string]string

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

type UpdateScopeInput 

type UpdateScopeInput struct {

	// The identifier for the scope that includes the resources you want to get data
	// results for. A scope ID is an internally-generated identifier that includes all
	// the resources for a specific root account.
	//
	// This member is required.
	ScopeId *string

	// A list of resources to add to a scope.
	ResourcesToAdd []types.TargetResource

	// A list of resources to delete from a scope.
	ResourcesToDelete []types.TargetResource
	// contains filtered or unexported fields
}

type UpdateScopeOutput 

type UpdateScopeOutput struct {

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

	// The identifier for the scope that includes the resources you want to get data
	// results for. A scope ID is an internally-generated identifier that includes all
	// the resources for a specific root account.
	//
	// This member is required.
	ScopeId *string

	// The status for a scope. The status can be one of the following: SUCCEEDED ,
	// IN_PROGRESS , FAILED , DEACTIVATING , or DEACTIVATED .
	//
	// A status of DEACTIVATING means that you've requested a scope to be deactivated
	// and Network Flow Monitor is in the process of deactivating the scope. A status
	// of DEACTIVATED means that the deactivating process is complete.
	//
	// This member is required.
	Status types.ScopeStatus

	// The tags for a scope.
	Tags map[string]string

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