Documentation
¶
Index ¶
- type AccessDeniedException
- type ConflictException
- type DestinationCategory
- type InternalServerException
- type KubernetesMetadata
- type MetricUnit
- type MonitorLocalResource
- type MonitorLocalResourceType
- type MonitorMetric
- type MonitorRemoteResource
- type MonitorRemoteResourceType
- type MonitorStatus
- type MonitorSummary
- type MonitorTopContributorsRow
- type QueryStatus
- type ResourceNotFoundException
- type ScopeStatus
- type ScopeSummary
- type ServiceQuotaExceededException
- type TargetId
- type TargetIdMemberAccountId
- type TargetIdentifier
- type TargetResource
- type TargetType
- type ThrottlingException
- type TraversedComponent
- type UnknownUnionMember
- type ValidationException
- type WorkloadInsightsMetric
- type WorkloadInsightsTopContributorsDataPoint
- type WorkloadInsightsTopContributorsRow
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccessDeniedException ¶
type AccessDeniedException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
You don't have sufficient permission to perform this action.
func (*AccessDeniedException) Error ¶
func (e *AccessDeniedException) Error() string
func (*AccessDeniedException) ErrorCode ¶
func (e *AccessDeniedException) ErrorCode() string
func (*AccessDeniedException) ErrorFault ¶
func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault
func (*AccessDeniedException) ErrorMessage ¶
func (e *AccessDeniedException) ErrorMessage() string
type ConflictException ¶
type ConflictException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
The requested resource is in use.
func (*ConflictException) Error ¶
func (e *ConflictException) Error() string
func (*ConflictException) ErrorCode ¶
func (e *ConflictException) ErrorCode() string
func (*ConflictException) ErrorFault ¶
func (e *ConflictException) ErrorFault() smithy.ErrorFault
func (*ConflictException) ErrorMessage ¶
func (e *ConflictException) ErrorMessage() string
type DestinationCategory ¶
type DestinationCategory string
const ( DestinationCategoryIntraAz DestinationCategory = "INTRA_AZ" DestinationCategoryInterAz DestinationCategory = "INTER_AZ" DestinationCategoryInterVpc DestinationCategory = "INTER_VPC" DestinationCategoryUnclassified DestinationCategory = "UNCLASSIFIED" DestinationCategoryAmazonS3 DestinationCategory = "AMAZON_S3" DestinationCategoryAmazonDynamodb DestinationCategory = "AMAZON_DYNAMODB" DestinationCategoryInterRegion DestinationCategory = "INTER_REGION" )
Enum values for DestinationCategory
func (DestinationCategory) Values ¶
func (DestinationCategory) Values() []DestinationCategory
Values returns all known values for DestinationCategory. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type InternalServerException ¶
type InternalServerException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
An internal error occurred.
func (*InternalServerException) Error ¶
func (e *InternalServerException) Error() string
func (*InternalServerException) ErrorCode ¶
func (e *InternalServerException) ErrorCode() string
func (*InternalServerException) ErrorFault ¶
func (e *InternalServerException) ErrorFault() smithy.ErrorFault
func (*InternalServerException) ErrorMessage ¶
func (e *InternalServerException) ErrorMessage() string
type KubernetesMetadata ¶
type KubernetesMetadata struct { // The name of the pod for a local resource. LocalPodName *string // The namespace of the pod for a local resource. LocalPodNamespace *string // The service name for a local resource. LocalServiceName *string // The name of the pod for a remote resource. RemotePodName *string // The namespace of the pod for a remote resource. RemotePodNamespace *string // The service name for a remote resource. RemoteServiceName *string // contains filtered or unexported fields }
Meta data about Kubernetes resources.
type MetricUnit ¶
type MetricUnit string
const ( MetricUnitSeconds MetricUnit = "Seconds" MetricUnitMicroseconds MetricUnit = "Microseconds" MetricUnitMilliseconds MetricUnit = "Milliseconds" MetricUnitBytes MetricUnit = "Bytes" MetricUnitKilobytes MetricUnit = "Kilobytes" MetricUnitMegabytes MetricUnit = "Megabytes" MetricUnitGigabytes MetricUnit = "Gigabytes" MetricUnitTerabytes MetricUnit = "Terabytes" MetricUnitBits MetricUnit = "Bits" MetricUnitKilobits MetricUnit = "Kilobits" MetricUnitMegabits MetricUnit = "Megabits" MetricUnitGigabits MetricUnit = "Gigabits" MetricUnitTerabits MetricUnit = "Terabits" MetricUnitPercent MetricUnit = "Percent" MetricUnitCount MetricUnit = "Count" MetricUnitBytesPerSecond MetricUnit = "Bytes/Second" MetricUnitKilobytesPerSecond MetricUnit = "Kilobytes/Second" MetricUnitMegabytesPerSecond MetricUnit = "Megabytes/Second" MetricUnitGigabytesPerSecond MetricUnit = "Gigabytes/Second" MetricUnitTerabytesPerSecond MetricUnit = "Terabytes/Second" MetricUnitBitsPerSecond MetricUnit = "Bits/Second" MetricUnitKilobitsPerSecond MetricUnit = "Kilobits/Second" MetricUnitMegabitsPerSecond MetricUnit = "Megabits/Second" MetricUnitGigabitsPerSecond MetricUnit = "Gigabits/Second" MetricUnitTerabitsPerSecond MetricUnit = "Terabits/Second" MetricUnitCountPerSecond MetricUnit = "Count/Second" MetricUnitNone MetricUnit = "None" )
Enum values for MetricUnit
func (MetricUnit) Values ¶
func (MetricUnit) Values() []MetricUnit
Values returns all known values for MetricUnit. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type MonitorLocalResource ¶
type MonitorLocalResource struct { // The identifier of the local resource. For a VPC or subnet, this identifier is // the VPC Amazon Resource Name (ARN) or subnet ARN. For an Availability Zone, this // identifier is the AZ name, for example, us-west-2b. // // This member is required. Identifier *string // The type of the local resource. Valid values are AWS::EC2::VPC // AWS::AvailabilityZone , AWS::EC2::Subnet , or AWS::Region . // // This member is required. Type MonitorLocalResourceType // contains filtered or unexported fields }
A local resource is the host where the agent is installed. Local resources can be a a subnet, a VPC, an Availability Zone, or an Amazon Web Services service.
type MonitorLocalResourceType ¶
type MonitorLocalResourceType string
const ( MonitorLocalResourceTypeAwsVpc MonitorLocalResourceType = "AWS::EC2::VPC" MonitorLocalResourceTypeAwsAz MonitorLocalResourceType = "AWS::AvailabilityZone" MonitorLocalResourceTypeAwsSubnet MonitorLocalResourceType = "AWS::EC2::Subnet" MonitorLocalResourceTypeAwsRegion MonitorLocalResourceType = "AWS::Region" )
Enum values for MonitorLocalResourceType
func (MonitorLocalResourceType) Values ¶
func (MonitorLocalResourceType) Values() []MonitorLocalResourceType
Values returns all known values for MonitorLocalResourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type MonitorMetric ¶
type MonitorMetric string
const ( MonitorMetricRoundTripTime MonitorMetric = "ROUND_TRIP_TIME" MonitorMetricTimeouts MonitorMetric = "TIMEOUTS" MonitorMetricRetransmissions MonitorMetric = "RETRANSMISSIONS" MonitorMetricDataTransferred MonitorMetric = "DATA_TRANSFERRED" )
Enum values for MonitorMetric
func (MonitorMetric) Values ¶
func (MonitorMetric) Values() []MonitorMetric
Values returns all known values for MonitorMetric. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type MonitorRemoteResource ¶
type MonitorRemoteResource struct { // The identifier of the remote resource. For a VPC or subnet, this identifier is // the VPC Amazon Resource Name (ARN) or subnet ARN. For an Availability Zone, this // identifier is the AZ name, for example, us-west-2b. For an Amazon Web Services // Region , this identifier is the Region name, for example, us-west-2. // // This member is required. Identifier *string // The type of the remote resource. Valid values are AWS::EC2::VPC // AWS::AvailabilityZone , AWS::EC2::Subnet , AWS::AWSService , or AWS::Region . // // This member is required. Type MonitorRemoteResourceType // contains filtered or unexported fields }
A remote resource is the other endpoint in a network flow. That is, one endpoint is the local resource and the other is the remote resource. Remote resources can be a a subnet, a VPC, an Availability Zone, an Amazon Web Services service, or an Amazon Web Services Region.
When a remote resource is an Amazon Web Services Region, Network Flow Monitor provides network performance measurements up to the edge of the Region that you specify.
type MonitorRemoteResourceType ¶
type MonitorRemoteResourceType string
const ( MonitorRemoteResourceTypeAwsVpc MonitorRemoteResourceType = "AWS::EC2::VPC" MonitorRemoteResourceTypeAwsAz MonitorRemoteResourceType = "AWS::AvailabilityZone" MonitorRemoteResourceTypeAwsSubnet MonitorRemoteResourceType = "AWS::EC2::Subnet" MonitorRemoteResourceTypeAwsService MonitorRemoteResourceType = "AWS::AWSService" MonitorRemoteResourceTypeAwsRegion MonitorRemoteResourceType = "AWS::Region" )
Enum values for MonitorRemoteResourceType
func (MonitorRemoteResourceType) Values ¶
func (MonitorRemoteResourceType) Values() []MonitorRemoteResourceType
Values returns all known values for MonitorRemoteResourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type MonitorStatus ¶
type MonitorStatus string
const ( MonitorStatusPending MonitorStatus = "PENDING" MonitorStatusActive MonitorStatus = "ACTIVE" MonitorStatusInactive MonitorStatus = "INACTIVE" MonitorStatusError MonitorStatus = "ERROR" MonitorStatusDeleting MonitorStatus = "DELETING" )
Enum values for MonitorStatus
func (MonitorStatus) Values ¶
func (MonitorStatus) Values() []MonitorStatus
Values returns all known values for MonitorStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type MonitorSummary ¶
type MonitorSummary struct { // 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 MonitorStatus // contains filtered or unexported fields }
A summary of information about a monitor, including the ARN, the name, and the status.
type MonitorTopContributorsRow ¶
type MonitorTopContributorsRow 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 DestinationCategory DestinationCategory // The destination network address translation (DNAT) IP address for a top // contributor network flow. DnatIp *string // Meta data about Kubernetes resources. KubernetesMetadata *KubernetesMetadata // The Availability Zone for the local resource for a top contributor network flow. LocalAz *string // The Amazon Resource Name (ARN) of a local resource. LocalInstanceArn *string // The instance identifier for the local resource for a top contributor network // flow. LocalInstanceId *string // The IP address of the local resource for a top contributor network flow. LocalIp *string // The Amazon Web Services Region for the local resource for a top contributor // network flow. LocalRegion *string // The Amazon Resource Name (ARN) of a local subnet. LocalSubnetArn *string // The subnet ID for the local resource for a top contributor network flow. LocalSubnetId *string // The Amazon Resource Name (ARN) of a local VPC. LocalVpcArn *string // The VPC ID for a top contributor network flow for the local resource. LocalVpcId *string // The Availability Zone for the remote resource for a top contributor network // flow. RemoteAz *string // The Amazon Resource Name (ARN) of a remote resource. RemoteInstanceArn *string // The instance identifier for the remote resource for a top contributor network // flow. RemoteInstanceId *string // The IP address of the remote resource for a top contributor network flow. RemoteIp *string // The Amazon Web Services Region for the remote resource for a top contributor // network flow. RemoteRegion *string // The Amazon Resource Name (ARN) of a remote subnet. RemoteSubnetArn *string // The subnet ID for the remote resource for a top contributor network flow. RemoteSubnetId *string // The Amazon Resource Name (ARN) of a remote VPC. RemoteVpcArn *string // The VPC ID for a top contributor network flow for the remote resource. RemoteVpcId *string // The secure network address translation (SNAT) IP address for a top contributor // network flow. SnatIp *string // The target port. TargetPort *int32 // The constructs traversed by a network flow. TraversedConstructs []TraversedComponent // The value of the metric for a top contributor network flow. Value *int64 // contains filtered or unexported fields }
A set of information for a top contributor network flow in a monitor. In a monitor, Network Flow Monitor returns information about the network flows for top contributors for each metric. Top contributors are network flows with the top values for each metric type.
type QueryStatus ¶
type QueryStatus string
const ( QueryStatusQueued QueryStatus = "QUEUED" QueryStatusRunning QueryStatus = "RUNNING" QueryStatusSucceeded QueryStatus = "SUCCEEDED" QueryStatusFailed QueryStatus = "FAILED" QueryStatusCanceled QueryStatus = "CANCELED" )
Enum values for QueryStatus
func (QueryStatus) Values ¶
func (QueryStatus) Values() []QueryStatus
Values returns all known values for QueryStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ResourceNotFoundException ¶
type ResourceNotFoundException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
The request specifies a resource that doesn't exist.
func (*ResourceNotFoundException) Error ¶
func (e *ResourceNotFoundException) Error() string
func (*ResourceNotFoundException) ErrorCode ¶
func (e *ResourceNotFoundException) ErrorCode() string
func (*ResourceNotFoundException) ErrorFault ¶
func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault
func (*ResourceNotFoundException) ErrorMessage ¶
func (e *ResourceNotFoundException) ErrorMessage() string
type ScopeStatus ¶
type ScopeStatus string
const ( ScopeStatusSucceeded ScopeStatus = "SUCCEEDED" ScopeStatusInProgress ScopeStatus = "IN_PROGRESS" ScopeStatusFailed ScopeStatus = "FAILED" ScopeStatusDeactivating ScopeStatus = "DEACTIVATING" ScopeStatusDeactivated ScopeStatus = "DEACTIVATED" )
Enum values for ScopeStatus
func (ScopeStatus) Values ¶
func (ScopeStatus) Values() []ScopeStatus
Values returns all known values for ScopeStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ScopeSummary ¶
type ScopeSummary struct { // The Amazon Resource Name (ARN) of the scope. // // This member is required. ScopeArn *string // The identifier for the scope that includes the resources that you want to get // data results for. A scope ID is an internally-generated identifier that includes // all the resources for the accounts in a scope. // // 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 ScopeStatus // contains filtered or unexported fields }
A summary of information about a scope, including the ARN, target ID, and Amazon Web Services Region.
type ServiceQuotaExceededException ¶
type ServiceQuotaExceededException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
The request exceeded a service quota.
func (*ServiceQuotaExceededException) Error ¶
func (e *ServiceQuotaExceededException) Error() string
func (*ServiceQuotaExceededException) ErrorCode ¶
func (e *ServiceQuotaExceededException) ErrorCode() string
func (*ServiceQuotaExceededException) ErrorFault ¶
func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault
func (*ServiceQuotaExceededException) ErrorMessage ¶
func (e *ServiceQuotaExceededException) ErrorMessage() string
type TargetId ¶
type TargetId interface {
// contains filtered or unexported methods
}
A target ID is an internally-generated identifier for a target. A target allows you to identify all the resources in a Network Flow Monitor scope. Currently, a target is always an Amazon Web Services account.
The following types satisfy this interface:
TargetIdMemberAccountId
Example (OutputUsage) ¶
// Code generated by smithy-go-codegen DO NOT EDIT. package main import ( "fmt" "github.com/aws/aws-sdk-go-v2/service/networkflowmonitor/types" ) func main() { var union types.TargetId // type switches can be used to check the union value switch v := union.(type) { case *types.TargetIdMemberAccountId: _ = v.Value // Value is string case *types.UnknownUnionMember: fmt.Println("unknown tag:", v.Tag) default: fmt.Println("union is nil or unknown type") } } var _ *string
type TargetIdMemberAccountId ¶
type TargetIdMemberAccountId struct { Value string // contains filtered or unexported fields }
The identifier for the account for a target.
type TargetIdentifier ¶
type TargetIdentifier struct { // The identifier for a target, which is currently always an account ID . // // This member is required. TargetId TargetId // The type of a target. A target type is currently always ACCOUNT . // // This member is required. TargetType TargetType // contains filtered or unexported fields }
A target identifier is a pair of identifying information for a scope that is included in a target. A target identifier is made up of a target ID and a target type. Currently the target ID is always an account ID and the target type is always ACCOUNT.
type TargetResource ¶
type TargetResource struct { // The Amazon Web Services Region for the scope. // // This member is required. Region *string // A target identifier is a pair of identifying information for a scope. A target // identifier is made up of a targetID (currently always an account ID) and a // targetType (currently always an account). // // This member is required. TargetIdentifier *TargetIdentifier // contains filtered or unexported fields }
A target resource in a scope. The resource is identified by a Region and an account, defined by a target identifier. A target identifier is made up of a target ID (currently always an account ID) and a target type (currently always ACCOUNT ).
type TargetType ¶
type TargetType string
const (
TargetTypeAccount TargetType = "ACCOUNT"
)
Enum values for TargetType
func (TargetType) Values ¶
func (TargetType) Values() []TargetType
Values returns all known values for TargetType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ThrottlingException ¶
type ThrottlingException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
The request was denied due to request throttling.
func (*ThrottlingException) Error ¶
func (e *ThrottlingException) Error() string
func (*ThrottlingException) ErrorCode ¶
func (e *ThrottlingException) ErrorCode() string
func (*ThrottlingException) ErrorFault ¶
func (e *ThrottlingException) ErrorFault() smithy.ErrorFault
func (*ThrottlingException) ErrorMessage ¶
func (e *ThrottlingException) ErrorMessage() string
type TraversedComponent ¶
type TraversedComponent struct { // The Amazon Resource Name (ARN) of a traversed component. ComponentArn *string // The identifier for the traversed component. ComponentId *string // The type of component that was traversed. ComponentType *string // The service name for the traversed component. ServiceName *string // contains filtered or unexported fields }
A section of the network that a network flow has traveled through.
type UnknownUnionMember ¶
type UnknownUnionMember struct { Tag string Value []byte // contains filtered or unexported fields }
UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.
type ValidationException ¶
type ValidationException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
Invalid request.
func (*ValidationException) Error ¶
func (e *ValidationException) Error() string
func (*ValidationException) ErrorCode ¶
func (e *ValidationException) ErrorCode() string
func (*ValidationException) ErrorFault ¶
func (e *ValidationException) ErrorFault() smithy.ErrorFault
func (*ValidationException) ErrorMessage ¶
func (e *ValidationException) ErrorMessage() string
type WorkloadInsightsMetric ¶
type WorkloadInsightsMetric string
const ( WorkloadInsightsMetricTimeouts WorkloadInsightsMetric = "TIMEOUTS" WorkloadInsightsMetricRetransmissions WorkloadInsightsMetric = "RETRANSMISSIONS" WorkloadInsightsMetricDataTransferred WorkloadInsightsMetric = "DATA_TRANSFERRED" )
Enum values for WorkloadInsightsMetric
func (WorkloadInsightsMetric) Values ¶
func (WorkloadInsightsMetric) Values() []WorkloadInsightsMetric
Values returns all known values for WorkloadInsightsMetric. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type WorkloadInsightsTopContributorsDataPoint ¶
type WorkloadInsightsTopContributorsDataPoint struct { // The label identifying the data point. // // This member is required. Label *string // An array of the timestamps for the data point. // // This member is required. Timestamps []time.Time // The values for the data point. // // This member is required. Values []float64 // contains filtered or unexported fields }
A data point for a top contributor network flow in a scope. Network Flow Monitor returns information about the network flows with the top values for each metric type, which are called top contributors.
type WorkloadInsightsTopContributorsRow ¶
type WorkloadInsightsTopContributorsRow struct { // The account ID for a specific row of data. AccountId *string // The identifier for the Availability Zone where the local resource is located. LocalAz *string // The Amazon Web Services Region where the local resource is located. LocalRegion *string // The Amazon Resource Name (ARN) of a local subnet. LocalSubnetArn *string // The subnet identifier for the local resource. LocalSubnetId *string // The Amazon Resource Name (ARN) of a local VPC. LocalVpcArn *string // The identifier for the VPC for the local resource. LocalVpcId *string // The identifier of a remote resource. For a VPC or subnet, this identifier is // the VPC Amazon Resource Name (ARN) or subnet ARN. For an Availability Zone, this // identifier is the AZ name, for example, us-west-2b. For an Amazon Web Services // Region , this identifier is the Region name, for example, us-west-2. RemoteIdentifier *string // The value for a metric. Value *int64 // contains filtered or unexported fields }
A row for a top contributor for a scope.