networkmonitor

package
v1.55.5 Latest Latest
Warning

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

Go to latest
Published: Jul 30, 2024 License: Apache-2.0 Imports: 10 Imported by: 1

Documentation

Overview

Package networkmonitor provides the client and types for making API requests to Amazon CloudWatch Network Monitor.

Amazon CloudWatch Network Monitor is an Amazon Web Services active network monitoring service that identifies if a network issues exists within the Amazon Web Services network or your own company network. Within Network Monitor you'll choose the source VPCs and subnets from the Amazon Web Services network in which you operate and then you'll choose the destination IP addresses from your on-premises network. From these sources and destinations, Network Monitor creates a monitor containing all the possible source and destination combinations, each of which is called a probe, within a single monitor. These probes then monitor network traffic to help you identify where network issues might be affecting your traffic.

Before you begin, ensure the Amazon Web Services CLI is configured in the Amazon Web Services Account where you will create the Network Monitor resource. Network Monitor doesn’t support creation on cross-account resources, but you can create a Network Monitor in any subnet belonging to a VPC owned by your Account.

For more information, see Using Amazon CloudWatch Network Monitor (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/what-is-network-monitor.html) in the Amazon CloudWatch User Guide.

See https://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01 for more information on this service.

See networkmonitor package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/networkmonitor/

Using the Client

To contact Amazon CloudWatch Network Monitor with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon CloudWatch Network Monitor client NetworkMonitor for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/networkmonitor/#New

Index

Constants

View Source
const (
	// AddressFamilyIpv4 is a AddressFamily enum value
	AddressFamilyIpv4 = "IPV4"

	// AddressFamilyIpv6 is a AddressFamily enum value
	AddressFamilyIpv6 = "IPV6"
)
View Source
const (
	// MonitorStatePending is a MonitorState enum value
	MonitorStatePending = "PENDING"

	// MonitorStateActive is a MonitorState enum value
	MonitorStateActive = "ACTIVE"

	// MonitorStateInactive is a MonitorState enum value
	MonitorStateInactive = "INACTIVE"

	// MonitorStateError is a MonitorState enum value
	MonitorStateError = "ERROR"

	// MonitorStateDeleting is a MonitorState enum value
	MonitorStateDeleting = "DELETING"
)
View Source
const (
	// ProbeStatePending is a ProbeState enum value
	ProbeStatePending = "PENDING"

	// ProbeStateActive is a ProbeState enum value
	ProbeStateActive = "ACTIVE"

	// ProbeStateInactive is a ProbeState enum value
	ProbeStateInactive = "INACTIVE"

	// ProbeStateError is a ProbeState enum value
	ProbeStateError = "ERROR"

	// ProbeStateDeleting is a ProbeState enum value
	ProbeStateDeleting = "DELETING"

	// ProbeStateDeleted is a ProbeState enum value
	ProbeStateDeleted = "DELETED"
)
View Source
const (
	// ProtocolTcp is a Protocol enum value
	ProtocolTcp = "TCP"

	// ProtocolIcmp is a Protocol enum value
	ProtocolIcmp = "ICMP"
)
View Source
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// You do not have sufficient access to perform this action.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// This operation attempted to create a resource that already exists.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// The request processing has failed because of an unknown error, exception
	// or failure.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The specified resource does not exist.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// This request exceeds a service quota.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The request was denied due to request throttling
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// One of the parameters for the request is not valid.
	ErrCodeValidationException = "ValidationException"
)
View Source
const (
	ServiceName = "NetworkMonitor" // Name of service.
	EndpointsID = "networkmonitor" // ID to lookup a service endpoint with.
	ServiceID   = "NetworkMonitor" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func AddressFamily_Values

func AddressFamily_Values() []string

AddressFamily_Values returns all elements of the AddressFamily enum

func MonitorState_Values

func MonitorState_Values() []string

MonitorState_Values returns all elements of the MonitorState enum

func ProbeState_Values

func ProbeState_Values() []string

ProbeState_Values returns all elements of the ProbeState enum

func Protocol_Values

func Protocol_Values() []string

Protocol_Values returns all elements of the Protocol enum

Types

type AccessDeniedException

type AccessDeniedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

You do not have sufficient access to perform this action.

func (*AccessDeniedException) Code

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) Message

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String

func (s AccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConflictException

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

This operation attempted to create a resource that already exists.

func (*ConflictException) Code

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error

func (s *ConflictException) Error() string

func (ConflictException) GoString

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) Message

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateMonitorInput

type CreateMonitorInput struct {

	// The time, in seconds, that metrics are aggregated and sent to Amazon CloudWatch.
	// Valid values are either 30 or 60. 60 is the default if no period is chosen.
	AggregationPeriod *int64 `locationName:"aggregationPeriod" min:"30" type:"long"`

	// Unique, case-sensitive identifier to ensure the idempotency of the request.
	// Only returned if a client token was provided in the request.
	ClientToken *string `locationName:"clientToken" type:"string" idempotencyToken:"true"`

	// The name identifying the monitor. It can contain only letters, underscores
	// (_), or dashes (-), and can be up to 200 characters.
	//
	// MonitorName is a required field
	MonitorName *string `locationName:"monitorName" min:"1" type:"string" required:"true"`

	// Displays a list of all of the probes created for a monitor.
	Probes []*CreateMonitorProbeInput_ `locationName:"probes" type:"list"`

	// The list of key-value pairs created and assigned to the monitor.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (CreateMonitorInput) GoString

func (s CreateMonitorInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateMonitorInput) SetAggregationPeriod

func (s *CreateMonitorInput) SetAggregationPeriod(v int64) *CreateMonitorInput

SetAggregationPeriod sets the AggregationPeriod field's value.

func (*CreateMonitorInput) SetClientToken

func (s *CreateMonitorInput) SetClientToken(v string) *CreateMonitorInput

SetClientToken sets the ClientToken field's value.

func (*CreateMonitorInput) SetMonitorName

func (s *CreateMonitorInput) SetMonitorName(v string) *CreateMonitorInput

SetMonitorName sets the MonitorName field's value.

func (*CreateMonitorInput) SetProbes

SetProbes sets the Probes field's value.

func (*CreateMonitorInput) SetTags

func (s *CreateMonitorInput) SetTags(v map[string]*string) *CreateMonitorInput

SetTags sets the Tags field's value.

func (CreateMonitorInput) String

func (s CreateMonitorInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateMonitorInput) Validate

func (s *CreateMonitorInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateMonitorOutput

type CreateMonitorOutput struct {

	// The number of seconds that metrics are aggregated by and sent to Amazon CloudWatch.
	// This will be either 30 or 60.
	AggregationPeriod *int64 `locationName:"aggregationPeriod" min:"30" type:"long"`

	// The ARN of the monitor.
	//
	// MonitorArn is a required field
	MonitorArn *string `locationName:"monitorArn" min:"20" type:"string" required:"true"`

	// The name of the monitor.
	//
	// MonitorName is a required field
	MonitorName *string `locationName:"monitorName" min:"1" type:"string" required:"true"`

	// The state of the monitor.
	//
	// State is a required field
	State *string `locationName:"state" type:"string" required:"true" enum:"MonitorState"`

	// The list of key-value pairs assigned to the monitor.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (CreateMonitorOutput) GoString

func (s CreateMonitorOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateMonitorOutput) SetAggregationPeriod

func (s *CreateMonitorOutput) SetAggregationPeriod(v int64) *CreateMonitorOutput

SetAggregationPeriod sets the AggregationPeriod field's value.

func (*CreateMonitorOutput) SetMonitorArn

func (s *CreateMonitorOutput) SetMonitorArn(v string) *CreateMonitorOutput

SetMonitorArn sets the MonitorArn field's value.

func (*CreateMonitorOutput) SetMonitorName

func (s *CreateMonitorOutput) SetMonitorName(v string) *CreateMonitorOutput

SetMonitorName sets the MonitorName field's value.

func (*CreateMonitorOutput) SetState

SetState sets the State field's value.

func (*CreateMonitorOutput) SetTags

SetTags sets the Tags field's value.

func (CreateMonitorOutput) String

func (s CreateMonitorOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateMonitorProbeInput_

type CreateMonitorProbeInput_ struct {

	// The destination IP address. This must be either IPV4 or IPV6.
	//
	// Destination is a required field
	Destination *string `locationName:"destination" min:"1" type:"string" required:"true"`

	// The port associated with the destination. This is required only if the protocol
	// is TCP and must be a number between 1 and 65536.
	DestinationPort *int64 `locationName:"destinationPort" type:"integer"`

	// The size of the packets sent between the source and destination. This must
	// be a number between 56 and 8500.
	PacketSize *int64 `locationName:"packetSize" min:"56" type:"integer"`

	// The list of key-value pairs created and assigned to the monitor.
	ProbeTags map[string]*string `locationName:"probeTags" type:"map"`

	// The protocol used for the network traffic between the source and destination.
	// This must be either TCP or ICMP.
	//
	// Protocol is a required field
	Protocol *string `locationName:"protocol" type:"string" required:"true" enum:"Protocol"`

	// The ARN of the subnet.
	//
	// SourceArn is a required field
	SourceArn *string `locationName:"sourceArn" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Creates a monitor probe.

func (CreateMonitorProbeInput_) GoString

func (s CreateMonitorProbeInput_) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateMonitorProbeInput_) SetDestination

SetDestination sets the Destination field's value.

func (*CreateMonitorProbeInput_) SetDestinationPort

func (s *CreateMonitorProbeInput_) SetDestinationPort(v int64) *CreateMonitorProbeInput_

SetDestinationPort sets the DestinationPort field's value.

func (*CreateMonitorProbeInput_) SetPacketSize

SetPacketSize sets the PacketSize field's value.

func (*CreateMonitorProbeInput_) SetProbeTags

SetProbeTags sets the ProbeTags field's value.

func (*CreateMonitorProbeInput_) SetProtocol

SetProtocol sets the Protocol field's value.

func (*CreateMonitorProbeInput_) SetSourceArn

SetSourceArn sets the SourceArn field's value.

func (CreateMonitorProbeInput_) String

func (s CreateMonitorProbeInput_) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateMonitorProbeInput_) Validate

func (s *CreateMonitorProbeInput_) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateProbeInput

type CreateProbeInput struct {

	// Unique, case-sensitive identifier to ensure the idempotency of the request.
	// Only returned if a client token was provided in the request.
	ClientToken *string `locationName:"clientToken" type:"string" idempotencyToken:"true"`

	// The name of the monitor to associated with the probe.
	//
	// MonitorName is a required field
	MonitorName *string `location:"uri" locationName:"monitorName" min:"1" type:"string" required:"true"`

	// Describes the details of an individual probe for a monitor.
	//
	// Probe is a required field
	Probe *ProbeInput_ `locationName:"probe" type:"structure" required:"true"`

	// The list of key-value pairs created and assigned to the probe.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (CreateProbeInput) GoString

func (s CreateProbeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateProbeInput) SetClientToken

func (s *CreateProbeInput) SetClientToken(v string) *CreateProbeInput

SetClientToken sets the ClientToken field's value.

func (*CreateProbeInput) SetMonitorName

func (s *CreateProbeInput) SetMonitorName(v string) *CreateProbeInput

SetMonitorName sets the MonitorName field's value.

func (*CreateProbeInput) SetProbe

SetProbe sets the Probe field's value.

func (*CreateProbeInput) SetTags

func (s *CreateProbeInput) SetTags(v map[string]*string) *CreateProbeInput

SetTags sets the Tags field's value.

func (CreateProbeInput) String

func (s CreateProbeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateProbeInput) Validate

func (s *CreateProbeInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateProbeOutput

type CreateProbeOutput struct {

	// Indicates whether the IP address is IPV4 or IPV6.
	AddressFamily *string `locationName:"addressFamily" type:"string" enum:"AddressFamily"`

	// The time and date that the probe was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The destination IP address for the monitor. This must be either an IPv4 or
	// IPv6 address.
	//
	// Destination is a required field
	Destination *string `locationName:"destination" min:"1" type:"string" required:"true"`

	// The port associated with the destination. This is required only if the protocol
	// is TCP and must be a number between 1 and 65536.
	DestinationPort *int64 `locationName:"destinationPort" type:"integer"`

	// The time and date when the probe was last modified.
	ModifiedAt *time.Time `locationName:"modifiedAt" type:"timestamp"`

	// The size of the packets sent between the source and destination. This must
	// be a number between 56 and 8500.
	PacketSize *int64 `locationName:"packetSize" min:"56" type:"integer"`

	// The ARN of the probe.
	ProbeArn *string `locationName:"probeArn" min:"20" type:"string"`

	// The ID of the probe for which details are returned.
	ProbeId *string `locationName:"probeId" type:"string"`

	// The protocol used for the network traffic between the source and destination.
	// This must be either TCP or ICMP.
	//
	// Protocol is a required field
	Protocol *string `locationName:"protocol" type:"string" required:"true" enum:"Protocol"`

	// The ARN of the probe.
	//
	// SourceArn is a required field
	SourceArn *string `locationName:"sourceArn" min:"20" type:"string" required:"true"`

	// The state of the probe.
	State *string `locationName:"state" type:"string" enum:"ProbeState"`

	// The list of key-value pairs assigned to the probe.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// The ID of the source VPC or subnet.
	VpcId *string `locationName:"vpcId" type:"string"`
	// contains filtered or unexported fields
}

func (CreateProbeOutput) GoString

func (s CreateProbeOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateProbeOutput) SetAddressFamily

func (s *CreateProbeOutput) SetAddressFamily(v string) *CreateProbeOutput

SetAddressFamily sets the AddressFamily field's value.

func (*CreateProbeOutput) SetCreatedAt

func (s *CreateProbeOutput) SetCreatedAt(v time.Time) *CreateProbeOutput

SetCreatedAt sets the CreatedAt field's value.

func (*CreateProbeOutput) SetDestination

func (s *CreateProbeOutput) SetDestination(v string) *CreateProbeOutput

SetDestination sets the Destination field's value.

func (*CreateProbeOutput) SetDestinationPort

func (s *CreateProbeOutput) SetDestinationPort(v int64) *CreateProbeOutput

SetDestinationPort sets the DestinationPort field's value.

func (*CreateProbeOutput) SetModifiedAt

func (s *CreateProbeOutput) SetModifiedAt(v time.Time) *CreateProbeOutput

SetModifiedAt sets the ModifiedAt field's value.

func (*CreateProbeOutput) SetPacketSize

func (s *CreateProbeOutput) SetPacketSize(v int64) *CreateProbeOutput

SetPacketSize sets the PacketSize field's value.

func (*CreateProbeOutput) SetProbeArn

func (s *CreateProbeOutput) SetProbeArn(v string) *CreateProbeOutput

SetProbeArn sets the ProbeArn field's value.

func (*CreateProbeOutput) SetProbeId

func (s *CreateProbeOutput) SetProbeId(v string) *CreateProbeOutput

SetProbeId sets the ProbeId field's value.

func (*CreateProbeOutput) SetProtocol

func (s *CreateProbeOutput) SetProtocol(v string) *CreateProbeOutput

SetProtocol sets the Protocol field's value.

func (*CreateProbeOutput) SetSourceArn

func (s *CreateProbeOutput) SetSourceArn(v string) *CreateProbeOutput

SetSourceArn sets the SourceArn field's value.

func (*CreateProbeOutput) SetState

func (s *CreateProbeOutput) SetState(v string) *CreateProbeOutput

SetState sets the State field's value.

func (*CreateProbeOutput) SetTags

func (s *CreateProbeOutput) SetTags(v map[string]*string) *CreateProbeOutput

SetTags sets the Tags field's value.

func (*CreateProbeOutput) SetVpcId

func (s *CreateProbeOutput) SetVpcId(v string) *CreateProbeOutput

SetVpcId sets the VpcId field's value.

func (CreateProbeOutput) String

func (s CreateProbeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteMonitorInput

type DeleteMonitorInput struct {

	// The name of the monitor to delete.
	//
	// MonitorName is a required field
	MonitorName *string `location:"uri" locationName:"monitorName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteMonitorInput) GoString

func (s DeleteMonitorInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteMonitorInput) SetMonitorName

func (s *DeleteMonitorInput) SetMonitorName(v string) *DeleteMonitorInput

SetMonitorName sets the MonitorName field's value.

func (DeleteMonitorInput) String

func (s DeleteMonitorInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteMonitorInput) Validate

func (s *DeleteMonitorInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteMonitorOutput

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

func (DeleteMonitorOutput) GoString

func (s DeleteMonitorOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteMonitorOutput) String

func (s DeleteMonitorOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteProbeInput

type DeleteProbeInput struct {

	// The name of the monitor to delete.
	//
	// MonitorName is a required field
	MonitorName *string `location:"uri" locationName:"monitorName" min:"1" type:"string" required:"true"`

	// The ID of the probe to delete.
	//
	// ProbeId is a required field
	ProbeId *string `location:"uri" locationName:"probeId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteProbeInput) GoString

func (s DeleteProbeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteProbeInput) SetMonitorName

func (s *DeleteProbeInput) SetMonitorName(v string) *DeleteProbeInput

SetMonitorName sets the MonitorName field's value.

func (*DeleteProbeInput) SetProbeId

func (s *DeleteProbeInput) SetProbeId(v string) *DeleteProbeInput

SetProbeId sets the ProbeId field's value.

func (DeleteProbeInput) String

func (s DeleteProbeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteProbeInput) Validate

func (s *DeleteProbeInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteProbeOutput

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

func (DeleteProbeOutput) GoString

func (s DeleteProbeOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteProbeOutput) String

func (s DeleteProbeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetMonitorInput

type GetMonitorInput struct {

	// The name of the monitor that details are returned for.
	//
	// MonitorName is a required field
	MonitorName *string `location:"uri" locationName:"monitorName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetMonitorInput) GoString

func (s GetMonitorInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetMonitorInput) SetMonitorName

func (s *GetMonitorInput) SetMonitorName(v string) *GetMonitorInput

SetMonitorName sets the MonitorName field's value.

func (GetMonitorInput) String

func (s GetMonitorInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetMonitorInput) Validate

func (s *GetMonitorInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetMonitorOutput

type GetMonitorOutput struct {

	// The aggregation period for the specified monitor.
	//
	// AggregationPeriod is a required field
	AggregationPeriod *int64 `locationName:"aggregationPeriod" min:"30" type:"long" required:"true"`

	// The time and date when the monitor was created.
	//
	// CreatedAt is a required field
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" required:"true"`

	// The time and date when the monitor was last modified.
	//
	// ModifiedAt is a required field
	ModifiedAt *time.Time `locationName:"modifiedAt" type:"timestamp" required:"true"`

	// The ARN of the selected monitor.
	//
	// MonitorArn is a required field
	MonitorArn *string `locationName:"monitorArn" min:"20" type:"string" required:"true"`

	// The name of the monitor.
	//
	// MonitorName is a required field
	MonitorName *string `locationName:"monitorName" min:"1" type:"string" required:"true"`

	// The details about each probe associated with that monitor.
	Probes []*Probe `locationName:"probes" type:"list"`

	// Lists the status of the state of each monitor.
	//
	// State is a required field
	State *string `locationName:"state" type:"string" required:"true" enum:"MonitorState"`

	// The list of key-value pairs assigned to the monitor.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (GetMonitorOutput) GoString

func (s GetMonitorOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetMonitorOutput) SetAggregationPeriod

func (s *GetMonitorOutput) SetAggregationPeriod(v int64) *GetMonitorOutput

SetAggregationPeriod sets the AggregationPeriod field's value.

func (*GetMonitorOutput) SetCreatedAt

func (s *GetMonitorOutput) SetCreatedAt(v time.Time) *GetMonitorOutput

SetCreatedAt sets the CreatedAt field's value.

func (*GetMonitorOutput) SetModifiedAt

func (s *GetMonitorOutput) SetModifiedAt(v time.Time) *GetMonitorOutput

SetModifiedAt sets the ModifiedAt field's value.

func (*GetMonitorOutput) SetMonitorArn

func (s *GetMonitorOutput) SetMonitorArn(v string) *GetMonitorOutput

SetMonitorArn sets the MonitorArn field's value.

func (*GetMonitorOutput) SetMonitorName

func (s *GetMonitorOutput) SetMonitorName(v string) *GetMonitorOutput

SetMonitorName sets the MonitorName field's value.

func (*GetMonitorOutput) SetProbes

func (s *GetMonitorOutput) SetProbes(v []*Probe) *GetMonitorOutput

SetProbes sets the Probes field's value.

func (*GetMonitorOutput) SetState

func (s *GetMonitorOutput) SetState(v string) *GetMonitorOutput

SetState sets the State field's value.

func (*GetMonitorOutput) SetTags

func (s *GetMonitorOutput) SetTags(v map[string]*string) *GetMonitorOutput

SetTags sets the Tags field's value.

func (GetMonitorOutput) String

func (s GetMonitorOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetProbeInput

type GetProbeInput struct {

	// The name of the monitor associated with the probe. Run ListMonitors to get
	// a list of monitor names.
	//
	// MonitorName is a required field
	MonitorName *string `location:"uri" locationName:"monitorName" min:"1" type:"string" required:"true"`

	// The ID of the probe to get information about. Run GetMonitor action to get
	// a list of probes and probe IDs for the monitor.
	//
	// ProbeId is a required field
	ProbeId *string `location:"uri" locationName:"probeId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetProbeInput) GoString

func (s GetProbeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetProbeInput) SetMonitorName

func (s *GetProbeInput) SetMonitorName(v string) *GetProbeInput

SetMonitorName sets the MonitorName field's value.

func (*GetProbeInput) SetProbeId

func (s *GetProbeInput) SetProbeId(v string) *GetProbeInput

SetProbeId sets the ProbeId field's value.

func (GetProbeInput) String

func (s GetProbeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetProbeInput) Validate

func (s *GetProbeInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetProbeOutput

type GetProbeOutput struct {

	// Indicates whether the IP address is IPV4 or IPV6.
	AddressFamily *string `locationName:"addressFamily" type:"string" enum:"AddressFamily"`

	// The time and date that the probe was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The destination IP address for the monitor. This must be either an IPv4 or
	// IPv6 address.
	//
	// Destination is a required field
	Destination *string `locationName:"destination" min:"1" type:"string" required:"true"`

	// The port associated with the destination. This is required only if the protocol
	// is TCP and must be a number between 1 and 65536.
	DestinationPort *int64 `locationName:"destinationPort" type:"integer"`

	// The time and date that the probe was last modified.
	ModifiedAt *time.Time `locationName:"modifiedAt" type:"timestamp"`

	// The size of the packets sent between the source and destination. This must
	// be a number between 56 and 8500.
	PacketSize *int64 `locationName:"packetSize" min:"56" type:"integer"`

	// The ARN of the probe.
	ProbeArn *string `locationName:"probeArn" min:"20" type:"string"`

	// The ID of the probe for which details are returned.
	ProbeId *string `locationName:"probeId" type:"string"`

	// The protocol used for the network traffic between the source and destination.
	// This must be either TCP or ICMP.
	//
	// Protocol is a required field
	Protocol *string `locationName:"protocol" type:"string" required:"true" enum:"Protocol"`

	// The ARN of the probe.
	//
	// SourceArn is a required field
	SourceArn *string `locationName:"sourceArn" min:"20" type:"string" required:"true"`

	// The state of the probe.
	State *string `locationName:"state" type:"string" enum:"ProbeState"`

	// The list of key-value pairs assigned to the probe.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// The ID of the source VPC or subnet.
	VpcId *string `locationName:"vpcId" type:"string"`
	// contains filtered or unexported fields
}

func (GetProbeOutput) GoString

func (s GetProbeOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetProbeOutput) SetAddressFamily

func (s *GetProbeOutput) SetAddressFamily(v string) *GetProbeOutput

SetAddressFamily sets the AddressFamily field's value.

func (*GetProbeOutput) SetCreatedAt

func (s *GetProbeOutput) SetCreatedAt(v time.Time) *GetProbeOutput

SetCreatedAt sets the CreatedAt field's value.

func (*GetProbeOutput) SetDestination

func (s *GetProbeOutput) SetDestination(v string) *GetProbeOutput

SetDestination sets the Destination field's value.

func (*GetProbeOutput) SetDestinationPort

func (s *GetProbeOutput) SetDestinationPort(v int64) *GetProbeOutput

SetDestinationPort sets the DestinationPort field's value.

func (*GetProbeOutput) SetModifiedAt

func (s *GetProbeOutput) SetModifiedAt(v time.Time) *GetProbeOutput

SetModifiedAt sets the ModifiedAt field's value.

func (*GetProbeOutput) SetPacketSize

func (s *GetProbeOutput) SetPacketSize(v int64) *GetProbeOutput

SetPacketSize sets the PacketSize field's value.

func (*GetProbeOutput) SetProbeArn

func (s *GetProbeOutput) SetProbeArn(v string) *GetProbeOutput

SetProbeArn sets the ProbeArn field's value.

func (*GetProbeOutput) SetProbeId

func (s *GetProbeOutput) SetProbeId(v string) *GetProbeOutput

SetProbeId sets the ProbeId field's value.

func (*GetProbeOutput) SetProtocol

func (s *GetProbeOutput) SetProtocol(v string) *GetProbeOutput

SetProtocol sets the Protocol field's value.

func (*GetProbeOutput) SetSourceArn

func (s *GetProbeOutput) SetSourceArn(v string) *GetProbeOutput

SetSourceArn sets the SourceArn field's value.

func (*GetProbeOutput) SetState

func (s *GetProbeOutput) SetState(v string) *GetProbeOutput

SetState sets the State field's value.

func (*GetProbeOutput) SetTags

func (s *GetProbeOutput) SetTags(v map[string]*string) *GetProbeOutput

SetTags sets the Tags field's value.

func (*GetProbeOutput) SetVpcId

func (s *GetProbeOutput) SetVpcId(v string) *GetProbeOutput

SetVpcId sets the VpcId field's value.

func (GetProbeOutput) String

func (s GetProbeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServerException

type InternalServerException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The request processing has failed because of an unknown error, exception or failure.

func (*InternalServerException) Code

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error

func (s *InternalServerException) Error() string

func (InternalServerException) GoString

func (s InternalServerException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerException) Message

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String

func (s InternalServerException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListMonitorsInput

type ListMonitorsInput struct {

	// The maximum number of results to return with a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	//
	// If MaxResults is given a value larger than 100, only 100 results are returned.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token for the next page of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// The list of all monitors and their states.
	State *string `location:"querystring" locationName:"state" type:"string"`
	// contains filtered or unexported fields
}

func (ListMonitorsInput) GoString

func (s ListMonitorsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListMonitorsInput) SetMaxResults

func (s *ListMonitorsInput) SetMaxResults(v int64) *ListMonitorsInput

SetMaxResults sets the MaxResults field's value.

func (*ListMonitorsInput) SetNextToken

func (s *ListMonitorsInput) SetNextToken(v string) *ListMonitorsInput

SetNextToken sets the NextToken field's value.

func (*ListMonitorsInput) SetState

func (s *ListMonitorsInput) SetState(v string) *ListMonitorsInput

SetState sets the State field's value.

func (ListMonitorsInput) String

func (s ListMonitorsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListMonitorsInput) Validate

func (s *ListMonitorsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListMonitorsOutput

type ListMonitorsOutput struct {

	// Lists individual details about each of your monitors.
	//
	// Monitors is a required field
	Monitors []*MonitorSummary `locationName:"monitors" type:"list" required:"true"`

	// The token for the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListMonitorsOutput) GoString

func (s ListMonitorsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListMonitorsOutput) SetMonitors

SetMonitors sets the Monitors field's value.

func (*ListMonitorsOutput) SetNextToken

func (s *ListMonitorsOutput) SetNextToken(v string) *ListMonitorsOutput

SetNextToken sets the NextToken field's value.

func (ListMonitorsOutput) String

func (s ListMonitorsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

	// The
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceArn

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

	// Lists the tags assigned to the resource.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MonitorSummary

type MonitorSummary struct {

	// The time, in seconds, that metrics are collected and sent to Amazon CloudWatch.
	// Valid values are either 30 or 60.
	AggregationPeriod *int64 `locationName:"aggregationPeriod" min:"30" type:"long"`

	// The ARN of the monitor.
	//
	// MonitorArn is a required field
	MonitorArn *string `locationName:"monitorArn" min:"20" type:"string" required:"true"`

	// The name of the monitor.
	//
	// MonitorName is a required field
	MonitorName *string `locationName:"monitorName" min:"1" type:"string" required:"true"`

	// The state of the monitor.
	//
	// State is a required field
	State *string `locationName:"state" type:"string" required:"true" enum:"MonitorState"`

	// The list of key-value pairs assigned to the monitor.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

Displays summary information about a monitor.

func (MonitorSummary) GoString

func (s MonitorSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MonitorSummary) SetAggregationPeriod

func (s *MonitorSummary) SetAggregationPeriod(v int64) *MonitorSummary

SetAggregationPeriod sets the AggregationPeriod field's value.

func (*MonitorSummary) SetMonitorArn

func (s *MonitorSummary) SetMonitorArn(v string) *MonitorSummary

SetMonitorArn sets the MonitorArn field's value.

func (*MonitorSummary) SetMonitorName

func (s *MonitorSummary) SetMonitorName(v string) *MonitorSummary

SetMonitorName sets the MonitorName field's value.

func (*MonitorSummary) SetState

func (s *MonitorSummary) SetState(v string) *MonitorSummary

SetState sets the State field's value.

func (*MonitorSummary) SetTags

func (s *MonitorSummary) SetTags(v map[string]*string) *MonitorSummary

SetTags sets the Tags field's value.

func (MonitorSummary) String

func (s MonitorSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NetworkMonitor

type NetworkMonitor struct {
	*client.Client
}

NetworkMonitor provides the API operation methods for making requests to Amazon CloudWatch Network Monitor. See this package's package overview docs for details on the service.

NetworkMonitor methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *NetworkMonitor

New creates a new instance of the NetworkMonitor client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a NetworkMonitor client from just a session.
svc := networkmonitor.New(mySession)

// Create a NetworkMonitor client with additional configuration
svc := networkmonitor.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*NetworkMonitor) CreateMonitor

func (c *NetworkMonitor) CreateMonitor(input *CreateMonitorInput) (*CreateMonitorOutput, error)

CreateMonitor API operation for Amazon CloudWatch Network Monitor.

Creates a monitor between a source subnet and destination IP address. Within a monitor you'll create one or more probes that monitor network traffic between your source Amazon Web Services VPC subnets and your destination IP addresses. Each probe then aggregates and sends metrics to Amazon CloudWatch.

You can also create a monitor with probes using this command. For each probe, you define the following:

  • source—The subnet IDs where the probes will be created.

  • destination— The target destination IP address for the probe.

  • destinationPort—Required only if the protocol is TCP.

  • protocol—The communication protocol between the source and destination. This will be either TCP or ICMP.

  • packetSize—The size of the packets. This must be a number between 56 and 8500.

  • (Optional) tags —Key-value pairs created and assigned to the probe.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Network Monitor's API operation CreateMonitor for usage and error information.

Returned Error Types:

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ThrottlingException The request was denied due to request throttling

  • ValidationException One of the parameters for the request is not valid.

  • InternalServerException The request processing has failed because of an unknown error, exception or failure.

  • ConflictException This operation attempted to create a resource that already exists.

  • ServiceQuotaExceededException This request exceeds a service quota.

See also, https://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/CreateMonitor

func (*NetworkMonitor) CreateMonitorRequest

func (c *NetworkMonitor) CreateMonitorRequest(input *CreateMonitorInput) (req *request.Request, output *CreateMonitorOutput)

CreateMonitorRequest generates a "aws/request.Request" representing the client's request for the CreateMonitor operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateMonitor for more information on using the CreateMonitor API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateMonitorRequest method.
req, resp := client.CreateMonitorRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/CreateMonitor

func (*NetworkMonitor) CreateMonitorWithContext

func (c *NetworkMonitor) CreateMonitorWithContext(ctx aws.Context, input *CreateMonitorInput, opts ...request.Option) (*CreateMonitorOutput, error)

CreateMonitorWithContext is the same as CreateMonitor with the addition of the ability to pass a context and additional request options.

See CreateMonitor for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkMonitor) CreateProbe

func (c *NetworkMonitor) CreateProbe(input *CreateProbeInput) (*CreateProbeOutput, error)

CreateProbe API operation for Amazon CloudWatch Network Monitor.

Create a probe within a monitor. Once you create a probe, and it begins monitoring your network traffic, you'll incur billing charges for that probe. This action requires the monitorName parameter. Run ListMonitors to get a list of monitor names. Note the name of the monitorName you want to create the probe for.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Network Monitor's API operation CreateProbe for usage and error information.

Returned Error Types:

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The request was denied due to request throttling

  • ValidationException One of the parameters for the request is not valid.

  • InternalServerException The request processing has failed because of an unknown error, exception or failure.

  • ServiceQuotaExceededException This request exceeds a service quota.

See also, https://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/CreateProbe

func (*NetworkMonitor) CreateProbeRequest

func (c *NetworkMonitor) CreateProbeRequest(input *CreateProbeInput) (req *request.Request, output *CreateProbeOutput)

CreateProbeRequest generates a "aws/request.Request" representing the client's request for the CreateProbe operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateProbe for more information on using the CreateProbe API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateProbeRequest method.
req, resp := client.CreateProbeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/CreateProbe

func (*NetworkMonitor) CreateProbeWithContext

func (c *NetworkMonitor) CreateProbeWithContext(ctx aws.Context, input *CreateProbeInput, opts ...request.Option) (*CreateProbeOutput, error)

CreateProbeWithContext is the same as CreateProbe with the addition of the ability to pass a context and additional request options.

See CreateProbe for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkMonitor) DeleteMonitor

func (c *NetworkMonitor) DeleteMonitor(input *DeleteMonitorInput) (*DeleteMonitorOutput, error)

DeleteMonitor API operation for Amazon CloudWatch Network Monitor.

Deletes a specified monitor.

This action requires the monitorName parameter. Run ListMonitors to get a list of monitor names.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Network Monitor's API operation DeleteMonitor for usage and error information.

Returned Error Types:

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The request was denied due to request throttling

  • ValidationException One of the parameters for the request is not valid.

  • InternalServerException The request processing has failed because of an unknown error, exception or failure.

See also, https://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/DeleteMonitor

func (*NetworkMonitor) DeleteMonitorRequest

func (c *NetworkMonitor) DeleteMonitorRequest(input *DeleteMonitorInput) (req *request.Request, output *DeleteMonitorOutput)

DeleteMonitorRequest generates a "aws/request.Request" representing the client's request for the DeleteMonitor operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteMonitor for more information on using the DeleteMonitor API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteMonitorRequest method.
req, resp := client.DeleteMonitorRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/DeleteMonitor

func (*NetworkMonitor) DeleteMonitorWithContext

func (c *NetworkMonitor) DeleteMonitorWithContext(ctx aws.Context, input *DeleteMonitorInput, opts ...request.Option) (*DeleteMonitorOutput, error)

DeleteMonitorWithContext is the same as DeleteMonitor with the addition of the ability to pass a context and additional request options.

See DeleteMonitor for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkMonitor) DeleteProbe

func (c *NetworkMonitor) DeleteProbe(input *DeleteProbeInput) (*DeleteProbeOutput, error)

DeleteProbe API operation for Amazon CloudWatch Network Monitor.

Deletes the specified probe. Once a probe is deleted you'll no longer incur any billing fees for that probe.

This action requires both the monitorName and probeId parameters. Run ListMonitors to get a list of monitor names. Run GetMonitor to get a list of probes and probe IDs. You can only delete a single probe at a time using this action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Network Monitor's API operation DeleteProbe for usage and error information.

Returned Error Types:

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The request was denied due to request throttling

  • ValidationException One of the parameters for the request is not valid.

  • InternalServerException The request processing has failed because of an unknown error, exception or failure.

  • ServiceQuotaExceededException This request exceeds a service quota.

See also, https://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/DeleteProbe

func (*NetworkMonitor) DeleteProbeRequest

func (c *NetworkMonitor) DeleteProbeRequest(input *DeleteProbeInput) (req *request.Request, output *DeleteProbeOutput)

DeleteProbeRequest generates a "aws/request.Request" representing the client's request for the DeleteProbe operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteProbe for more information on using the DeleteProbe API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteProbeRequest method.
req, resp := client.DeleteProbeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/DeleteProbe

func (*NetworkMonitor) DeleteProbeWithContext

func (c *NetworkMonitor) DeleteProbeWithContext(ctx aws.Context, input *DeleteProbeInput, opts ...request.Option) (*DeleteProbeOutput, error)

DeleteProbeWithContext is the same as DeleteProbe with the addition of the ability to pass a context and additional request options.

See DeleteProbe for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkMonitor) GetMonitor

func (c *NetworkMonitor) GetMonitor(input *GetMonitorInput) (*GetMonitorOutput, error)

GetMonitor API operation for Amazon CloudWatch Network Monitor.

Returns details about a specific monitor.

This action requires the monitorName parameter. Run ListMonitors to get a list of monitor names.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Network Monitor's API operation GetMonitor for usage and error information.

Returned Error Types:

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The request was denied due to request throttling

  • ValidationException One of the parameters for the request is not valid.

  • InternalServerException The request processing has failed because of an unknown error, exception or failure.

See also, https://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/GetMonitor

func (*NetworkMonitor) GetMonitorRequest

func (c *NetworkMonitor) GetMonitorRequest(input *GetMonitorInput) (req *request.Request, output *GetMonitorOutput)

GetMonitorRequest generates a "aws/request.Request" representing the client's request for the GetMonitor operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetMonitor for more information on using the GetMonitor API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetMonitorRequest method.
req, resp := client.GetMonitorRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/GetMonitor

func (*NetworkMonitor) GetMonitorWithContext

func (c *NetworkMonitor) GetMonitorWithContext(ctx aws.Context, input *GetMonitorInput, opts ...request.Option) (*GetMonitorOutput, error)

GetMonitorWithContext is the same as GetMonitor with the addition of the ability to pass a context and additional request options.

See GetMonitor for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkMonitor) GetProbe

func (c *NetworkMonitor) GetProbe(input *GetProbeInput) (*GetProbeOutput, error)

GetProbe API operation for Amazon CloudWatch Network Monitor.

Returns the details about a probe. This action requires both the monitorName and probeId parameters. Run ListMonitors to get a list of monitor names. Run GetMonitor to get a list of probes and probe IDs.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Network Monitor's API operation GetProbe for usage and error information.

Returned Error Types:

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The request was denied due to request throttling

  • ValidationException One of the parameters for the request is not valid.

  • InternalServerException The request processing has failed because of an unknown error, exception or failure.

See also, https://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/GetProbe

func (*NetworkMonitor) GetProbeRequest

func (c *NetworkMonitor) GetProbeRequest(input *GetProbeInput) (req *request.Request, output *GetProbeOutput)

GetProbeRequest generates a "aws/request.Request" representing the client's request for the GetProbe operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetProbe for more information on using the GetProbe API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetProbeRequest method.
req, resp := client.GetProbeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/GetProbe

func (*NetworkMonitor) GetProbeWithContext

func (c *NetworkMonitor) GetProbeWithContext(ctx aws.Context, input *GetProbeInput, opts ...request.Option) (*GetProbeOutput, error)

GetProbeWithContext is the same as GetProbe with the addition of the ability to pass a context and additional request options.

See GetProbe for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkMonitor) ListMonitors

func (c *NetworkMonitor) ListMonitors(input *ListMonitorsInput) (*ListMonitorsOutput, error)

ListMonitors API operation for Amazon CloudWatch Network Monitor.

Returns a list of all of your monitors.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Network Monitor's API operation ListMonitors for usage and error information.

Returned Error Types:

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ThrottlingException The request was denied due to request throttling

  • ValidationException One of the parameters for the request is not valid.

  • InternalServerException The request processing has failed because of an unknown error, exception or failure.

See also, https://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/ListMonitors

func (*NetworkMonitor) ListMonitorsPages

func (c *NetworkMonitor) ListMonitorsPages(input *ListMonitorsInput, fn func(*ListMonitorsOutput, bool) bool) error

ListMonitorsPages iterates over the pages of a ListMonitors operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListMonitors method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListMonitors operation.
pageNum := 0
err := client.ListMonitorsPages(params,
    func(page *networkmonitor.ListMonitorsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*NetworkMonitor) ListMonitorsPagesWithContext

func (c *NetworkMonitor) ListMonitorsPagesWithContext(ctx aws.Context, input *ListMonitorsInput, fn func(*ListMonitorsOutput, bool) bool, opts ...request.Option) error

ListMonitorsPagesWithContext same as ListMonitorsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkMonitor) ListMonitorsRequest

func (c *NetworkMonitor) ListMonitorsRequest(input *ListMonitorsInput) (req *request.Request, output *ListMonitorsOutput)

ListMonitorsRequest generates a "aws/request.Request" representing the client's request for the ListMonitors operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListMonitors for more information on using the ListMonitors API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListMonitorsRequest method.
req, resp := client.ListMonitorsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/ListMonitors

func (*NetworkMonitor) ListMonitorsWithContext

func (c *NetworkMonitor) ListMonitorsWithContext(ctx aws.Context, input *ListMonitorsInput, opts ...request.Option) (*ListMonitorsOutput, error)

ListMonitorsWithContext is the same as ListMonitors with the addition of the ability to pass a context and additional request options.

See ListMonitors for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkMonitor) ListTagsForResource

func (c *NetworkMonitor) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon CloudWatch Network Monitor.

Lists the tags assigned to this resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Network Monitor's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The request was denied due to request throttling

  • ValidationException One of the parameters for the request is not valid.

  • InternalServerException The request processing has failed because of an unknown error, exception or failure.

  • ConflictException This operation attempted to create a resource that already exists.

See also, https://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/ListTagsForResource

func (*NetworkMonitor) ListTagsForResourceRequest

func (c *NetworkMonitor) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/ListTagsForResource

func (*NetworkMonitor) ListTagsForResourceWithContext

func (c *NetworkMonitor) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkMonitor) TagResource

func (c *NetworkMonitor) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Amazon CloudWatch Network Monitor.

Adds key-value pairs to a monitor or probe.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Network Monitor's API operation TagResource for usage and error information.

Returned Error Types:

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The request was denied due to request throttling

  • ValidationException One of the parameters for the request is not valid.

  • InternalServerException The request processing has failed because of an unknown error, exception or failure.

  • ConflictException This operation attempted to create a resource that already exists.

See also, https://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/TagResource

func (*NetworkMonitor) TagResourceRequest

func (c *NetworkMonitor) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/TagResource

func (*NetworkMonitor) TagResourceWithContext

func (c *NetworkMonitor) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkMonitor) UntagResource

func (c *NetworkMonitor) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon CloudWatch Network Monitor.

Removes a key-value pair from a monitor or probe.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Network Monitor's API operation UntagResource for usage and error information.

Returned Error Types:

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The request was denied due to request throttling

  • ValidationException One of the parameters for the request is not valid.

  • InternalServerException The request processing has failed because of an unknown error, exception or failure.

  • ConflictException This operation attempted to create a resource that already exists.

See also, https://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/UntagResource

func (*NetworkMonitor) UntagResourceRequest

func (c *NetworkMonitor) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/UntagResource

func (*NetworkMonitor) UntagResourceWithContext

func (c *NetworkMonitor) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkMonitor) UpdateMonitor

func (c *NetworkMonitor) UpdateMonitor(input *UpdateMonitorInput) (*UpdateMonitorOutput, error)

UpdateMonitor API operation for Amazon CloudWatch Network Monitor.

Updates the aggregationPeriod for a monitor. Monitors support an aggregationPeriod of either 30 or 60 seconds. This action requires the monitorName and probeId parameter. Run ListMonitors to get a list of monitor names.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Network Monitor's API operation UpdateMonitor for usage and error information.

Returned Error Types:

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The request was denied due to request throttling

  • ValidationException One of the parameters for the request is not valid.

  • InternalServerException The request processing has failed because of an unknown error, exception or failure.

  • ServiceQuotaExceededException This request exceeds a service quota.

See also, https://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/UpdateMonitor

func (*NetworkMonitor) UpdateMonitorRequest

func (c *NetworkMonitor) UpdateMonitorRequest(input *UpdateMonitorInput) (req *request.Request, output *UpdateMonitorOutput)

UpdateMonitorRequest generates a "aws/request.Request" representing the client's request for the UpdateMonitor operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateMonitor for more information on using the UpdateMonitor API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateMonitorRequest method.
req, resp := client.UpdateMonitorRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/UpdateMonitor

func (*NetworkMonitor) UpdateMonitorWithContext

func (c *NetworkMonitor) UpdateMonitorWithContext(ctx aws.Context, input *UpdateMonitorInput, opts ...request.Option) (*UpdateMonitorOutput, error)

UpdateMonitorWithContext is the same as UpdateMonitor with the addition of the ability to pass a context and additional request options.

See UpdateMonitor for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkMonitor) UpdateProbe

func (c *NetworkMonitor) UpdateProbe(input *UpdateProbeInput) (*UpdateProbeOutput, error)

UpdateProbe API operation for Amazon CloudWatch Network Monitor.

Updates a monitor probe. This action requires both the monitorName and probeId parameters. Run ListMonitors to get a list of monitor names. Run GetMonitor to get a list of probes and probe IDs.

You can update the following para create a monitor with probes using this command. For each probe, you define the following:

  • state—The state of the probe.

  • destination— The target destination IP address for the probe.

  • destinationPort—Required only if the protocol is TCP.

  • protocol—The communication protocol between the source and destination. This will be either TCP or ICMP.

  • packetSize—The size of the packets. This must be a number between 56 and 8500.

  • (Optional) tags —Key-value pairs created and assigned to the probe.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Network Monitor's API operation UpdateProbe for usage and error information.

Returned Error Types:

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The request was denied due to request throttling

  • ValidationException One of the parameters for the request is not valid.

  • InternalServerException The request processing has failed because of an unknown error, exception or failure.

  • ServiceQuotaExceededException This request exceeds a service quota.

See also, https://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/UpdateProbe

func (*NetworkMonitor) UpdateProbeRequest

func (c *NetworkMonitor) UpdateProbeRequest(input *UpdateProbeInput) (req *request.Request, output *UpdateProbeOutput)

UpdateProbeRequest generates a "aws/request.Request" representing the client's request for the UpdateProbe operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateProbe for more information on using the UpdateProbe API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateProbeRequest method.
req, resp := client.UpdateProbeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/UpdateProbe

func (*NetworkMonitor) UpdateProbeWithContext

func (c *NetworkMonitor) UpdateProbeWithContext(ctx aws.Context, input *UpdateProbeInput, opts ...request.Option) (*UpdateProbeOutput, error)

UpdateProbeWithContext is the same as UpdateProbe with the addition of the ability to pass a context and additional request options.

See UpdateProbe for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type Probe

type Probe struct {

	// The IPv4 or IPv6 address for the probe.
	AddressFamily *string `locationName:"addressFamily" type:"string" enum:"AddressFamily"`

	// The time and date the probe was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The destination for the probe. This should be either an IPV4 or IPV6.
	//
	// Destination is a required field
	Destination *string `locationName:"destination" min:"1" type:"string" required:"true"`

	// The destination port for the probe. This is required only if the protocol
	// is TCP and must be a number between 1 and 65536.
	DestinationPort *int64 `locationName:"destinationPort" type:"integer"`

	// The time and date that the probe was last modified.
	ModifiedAt *time.Time `locationName:"modifiedAt" type:"timestamp"`

	// The size of the packets traveling between the source and destination. This
	// must be a number between 56 and
	PacketSize *int64 `locationName:"packetSize" min:"56" type:"integer"`

	// The ARN of the probe.
	ProbeArn *string `locationName:"probeArn" min:"20" type:"string"`

	// The ID of the probe.
	ProbeId *string `locationName:"probeId" type:"string"`

	// The network protocol for the destination. This can be either TCP or ICMP.
	// If the protocol is TCP, then port is also required.
	//
	// Protocol is a required field
	Protocol *string `locationName:"protocol" type:"string" required:"true" enum:"Protocol"`

	// The ARN of the probe source subnet.
	//
	// SourceArn is a required field
	SourceArn *string `locationName:"sourceArn" min:"20" type:"string" required:"true"`

	// The state of the probe.
	State *string `locationName:"state" type:"string" enum:"ProbeState"`

	// The list of key-value pairs created and assigned to the probe.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// The ID of the source VPC subnet.
	VpcId *string `locationName:"vpcId" type:"string"`
	// contains filtered or unexported fields
}

Describes information about a network monitor probe.

func (Probe) GoString

func (s Probe) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Probe) SetAddressFamily

func (s *Probe) SetAddressFamily(v string) *Probe

SetAddressFamily sets the AddressFamily field's value.

func (*Probe) SetCreatedAt

func (s *Probe) SetCreatedAt(v time.Time) *Probe

SetCreatedAt sets the CreatedAt field's value.

func (*Probe) SetDestination

func (s *Probe) SetDestination(v string) *Probe

SetDestination sets the Destination field's value.

func (*Probe) SetDestinationPort

func (s *Probe) SetDestinationPort(v int64) *Probe

SetDestinationPort sets the DestinationPort field's value.

func (*Probe) SetModifiedAt

func (s *Probe) SetModifiedAt(v time.Time) *Probe

SetModifiedAt sets the ModifiedAt field's value.

func (*Probe) SetPacketSize

func (s *Probe) SetPacketSize(v int64) *Probe

SetPacketSize sets the PacketSize field's value.

func (*Probe) SetProbeArn

func (s *Probe) SetProbeArn(v string) *Probe

SetProbeArn sets the ProbeArn field's value.

func (*Probe) SetProbeId

func (s *Probe) SetProbeId(v string) *Probe

SetProbeId sets the ProbeId field's value.

func (*Probe) SetProtocol

func (s *Probe) SetProtocol(v string) *Probe

SetProtocol sets the Protocol field's value.

func (*Probe) SetSourceArn

func (s *Probe) SetSourceArn(v string) *Probe

SetSourceArn sets the SourceArn field's value.

func (*Probe) SetState

func (s *Probe) SetState(v string) *Probe

SetState sets the State field's value.

func (*Probe) SetTags

func (s *Probe) SetTags(v map[string]*string) *Probe

SetTags sets the Tags field's value.

func (*Probe) SetVpcId

func (s *Probe) SetVpcId(v string) *Probe

SetVpcId sets the VpcId field's value.

func (Probe) String

func (s Probe) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ProbeInput_

type ProbeInput_ struct {

	// The destination IP address. This must be either IPV4 or IPV6.
	//
	// Destination is a required field
	Destination *string `locationName:"destination" min:"1" type:"string" required:"true"`

	// The port associated with the destination. This is required only if the protocol
	// is TCP and must be a number between 1 and 65536.
	DestinationPort *int64 `locationName:"destinationPort" type:"integer"`

	// The size of the packets sent between the source and destination. This must
	// be a number between 56 and 8500.
	PacketSize *int64 `locationName:"packetSize" min:"56" type:"integer"`

	// The protocol used for the network traffic between the source and destination.
	// This must be either TCP or ICMP.
	//
	// Protocol is a required field
	Protocol *string `locationName:"protocol" type:"string" required:"true" enum:"Protocol"`

	// The ARN of the subnet.
	//
	// SourceArn is a required field
	SourceArn *string `locationName:"sourceArn" min:"20" type:"string" required:"true"`

	// The list of key-value pairs created and assigned to the monitor.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

Defines a probe when creating a probe or monitor.

func (ProbeInput_) GoString

func (s ProbeInput_) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ProbeInput_) SetDestination

func (s *ProbeInput_) SetDestination(v string) *ProbeInput_

SetDestination sets the Destination field's value.

func (*ProbeInput_) SetDestinationPort

func (s *ProbeInput_) SetDestinationPort(v int64) *ProbeInput_

SetDestinationPort sets the DestinationPort field's value.

func (*ProbeInput_) SetPacketSize

func (s *ProbeInput_) SetPacketSize(v int64) *ProbeInput_

SetPacketSize sets the PacketSize field's value.

func (*ProbeInput_) SetProtocol

func (s *ProbeInput_) SetProtocol(v string) *ProbeInput_

SetProtocol sets the Protocol field's value.

func (*ProbeInput_) SetSourceArn

func (s *ProbeInput_) SetSourceArn(v string) *ProbeInput_

SetSourceArn sets the SourceArn field's value.

func (*ProbeInput_) SetTags

func (s *ProbeInput_) SetTags(v map[string]*string) *ProbeInput_

SetTags sets the Tags field's value.

func (ProbeInput_) String

func (s ProbeInput_) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ProbeInput_) Validate

func (s *ProbeInput_) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResourceNotFoundException

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The specified resource does not exist.

func (*ResourceNotFoundException) Code

Code returns the exception type name.

func (*ResourceNotFoundException) Error

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServiceQuotaExceededException

type ServiceQuotaExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

This request exceeds a service quota.

func (*ServiceQuotaExceededException) Code

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error

func (ServiceQuotaExceededException) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceQuotaExceededException) Message

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode

func (s *ServiceQuotaExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceQuotaExceededException) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TagResourceInput

type TagResourceInput struct {

	// The ARN of the monitor or probe to tag.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" min:"20" type:"string" required:"true"`

	// The list of key-value pairs assigned to the monitor or probe.
	//
	// Tags is a required field
	Tags map[string]*string `locationName:"tags" type:"map" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceArn

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags

func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput

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

func (TagResourceOutput) GoString

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThrottlingException

type ThrottlingException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The request was denied due to request throttling

func (*ThrottlingException) Code

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString

func (s ThrottlingException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThrottlingException) Message

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String

func (s ThrottlingException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput

type UntagResourceInput struct {

	// The ARN of the monitor or probe that the tag should be removed from.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" min:"20" type:"string" required:"true"`

	// The key-value pa
	//
	// TagKeys is a required field
	TagKeys []*string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceArn

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput

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

func (UntagResourceOutput) GoString

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateMonitorInput

type UpdateMonitorInput struct {

	// The aggregation time, in seconds, to change to. This must be either 30 or
	// 60.
	//
	// AggregationPeriod is a required field
	AggregationPeriod *int64 `locationName:"aggregationPeriod" min:"30" type:"long" required:"true"`

	// The name of the monitor to update.
	//
	// MonitorName is a required field
	MonitorName *string `location:"uri" locationName:"monitorName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateMonitorInput) GoString

func (s UpdateMonitorInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateMonitorInput) SetAggregationPeriod

func (s *UpdateMonitorInput) SetAggregationPeriod(v int64) *UpdateMonitorInput

SetAggregationPeriod sets the AggregationPeriod field's value.

func (*UpdateMonitorInput) SetMonitorName

func (s *UpdateMonitorInput) SetMonitorName(v string) *UpdateMonitorInput

SetMonitorName sets the MonitorName field's value.

func (UpdateMonitorInput) String

func (s UpdateMonitorInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateMonitorInput) Validate

func (s *UpdateMonitorInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateMonitorOutput

type UpdateMonitorOutput struct {

	// The changed aggregation period.
	AggregationPeriod *int64 `locationName:"aggregationPeriod" min:"30" type:"long"`

	// The ARN of the monitor that was updated.
	//
	// MonitorArn is a required field
	MonitorArn *string `locationName:"monitorArn" min:"20" type:"string" required:"true"`

	// The name of the monitor that was updated.
	//
	// MonitorName is a required field
	MonitorName *string `locationName:"monitorName" min:"1" type:"string" required:"true"`

	// The state of the updated monitor.
	//
	// State is a required field
	State *string `locationName:"state" type:"string" required:"true" enum:"MonitorState"`

	// The list of key-value pairs associated with the monitor.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (UpdateMonitorOutput) GoString

func (s UpdateMonitorOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateMonitorOutput) SetAggregationPeriod

func (s *UpdateMonitorOutput) SetAggregationPeriod(v int64) *UpdateMonitorOutput

SetAggregationPeriod sets the AggregationPeriod field's value.

func (*UpdateMonitorOutput) SetMonitorArn

func (s *UpdateMonitorOutput) SetMonitorArn(v string) *UpdateMonitorOutput

SetMonitorArn sets the MonitorArn field's value.

func (*UpdateMonitorOutput) SetMonitorName

func (s *UpdateMonitorOutput) SetMonitorName(v string) *UpdateMonitorOutput

SetMonitorName sets the MonitorName field's value.

func (*UpdateMonitorOutput) SetState

SetState sets the State field's value.

func (*UpdateMonitorOutput) SetTags

SetTags sets the Tags field's value.

func (UpdateMonitorOutput) String

func (s UpdateMonitorOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateProbeInput

type UpdateProbeInput struct {

	// The updated IP address for the probe destination. This must be either an
	// IPv4 or IPv6 address.
	Destination *string `locationName:"destination" min:"1" type:"string"`

	// The updated port for the probe destination. This is required only if the
	// protocol is TCP and must be a number between 1 and 65536.
	DestinationPort *int64 `locationName:"destinationPort" type:"integer"`

	// The name of the monitor that the probe was updated for.
	//
	// MonitorName is a required field
	MonitorName *string `location:"uri" locationName:"monitorName" min:"1" type:"string" required:"true"`

	// he updated packets size for network traffic between the source and destination.
	// This must be a number between 56 and 8500.
	PacketSize *int64 `locationName:"packetSize" min:"56" type:"integer"`

	// The ID of the probe to update.
	//
	// ProbeId is a required field
	ProbeId *string `location:"uri" locationName:"probeId" type:"string" required:"true"`

	// The updated network protocol for the destination. This can be either TCP
	// or ICMP. If the protocol is TCP, then port is also required.
	Protocol *string `locationName:"protocol" type:"string" enum:"Protocol"`

	// The state of the probe update.
	State *string `locationName:"state" type:"string" enum:"ProbeState"`
	// contains filtered or unexported fields
}

func (UpdateProbeInput) GoString

func (s UpdateProbeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateProbeInput) SetDestination

func (s *UpdateProbeInput) SetDestination(v string) *UpdateProbeInput

SetDestination sets the Destination field's value.

func (*UpdateProbeInput) SetDestinationPort

func (s *UpdateProbeInput) SetDestinationPort(v int64) *UpdateProbeInput

SetDestinationPort sets the DestinationPort field's value.

func (*UpdateProbeInput) SetMonitorName

func (s *UpdateProbeInput) SetMonitorName(v string) *UpdateProbeInput

SetMonitorName sets the MonitorName field's value.

func (*UpdateProbeInput) SetPacketSize

func (s *UpdateProbeInput) SetPacketSize(v int64) *UpdateProbeInput

SetPacketSize sets the PacketSize field's value.

func (*UpdateProbeInput) SetProbeId

func (s *UpdateProbeInput) SetProbeId(v string) *UpdateProbeInput

SetProbeId sets the ProbeId field's value.

func (*UpdateProbeInput) SetProtocol

func (s *UpdateProbeInput) SetProtocol(v string) *UpdateProbeInput

SetProtocol sets the Protocol field's value.

func (*UpdateProbeInput) SetState

func (s *UpdateProbeInput) SetState(v string) *UpdateProbeInput

SetState sets the State field's value.

func (UpdateProbeInput) String

func (s UpdateProbeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateProbeInput) Validate

func (s *UpdateProbeInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateProbeOutput

type UpdateProbeOutput struct {

	// The updated IP address family. This must be either IPV4 or IPV6.
	AddressFamily *string `locationName:"addressFamily" type:"string" enum:"AddressFamily"`

	// The time and date that the probe was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The updated destination IP address for the probe.
	//
	// Destination is a required field
	Destination *string `locationName:"destination" min:"1" type:"string" required:"true"`

	// The updated destination port. This must be a number between 1 and 65536.
	DestinationPort *int64 `locationName:"destinationPort" type:"integer"`

	// The time and date that the probe was last updated.
	ModifiedAt *time.Time `locationName:"modifiedAt" type:"timestamp"`

	// The updated packet size for the probe.
	PacketSize *int64 `locationName:"packetSize" min:"56" type:"integer"`

	// The updated ARN of the probe.
	ProbeArn *string `locationName:"probeArn" min:"20" type:"string"`

	// The updated ID of the probe.
	ProbeId *string `locationName:"probeId" type:"string"`

	// The updated protocol for the probe.
	//
	// Protocol is a required field
	Protocol *string `locationName:"protocol" type:"string" required:"true" enum:"Protocol"`

	// The updated ARN of the source subnet.
	//
	// SourceArn is a required field
	SourceArn *string `locationName:"sourceArn" min:"20" type:"string" required:"true"`

	// The state of the updated probe.
	State *string `locationName:"state" type:"string" enum:"ProbeState"`

	// Update tags for a probe.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// The updated ID of the source VPC subnet ID.
	VpcId *string `locationName:"vpcId" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateProbeOutput) GoString

func (s UpdateProbeOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateProbeOutput) SetAddressFamily

func (s *UpdateProbeOutput) SetAddressFamily(v string) *UpdateProbeOutput

SetAddressFamily sets the AddressFamily field's value.

func (*UpdateProbeOutput) SetCreatedAt

func (s *UpdateProbeOutput) SetCreatedAt(v time.Time) *UpdateProbeOutput

SetCreatedAt sets the CreatedAt field's value.

func (*UpdateProbeOutput) SetDestination

func (s *UpdateProbeOutput) SetDestination(v string) *UpdateProbeOutput

SetDestination sets the Destination field's value.

func (*UpdateProbeOutput) SetDestinationPort

func (s *UpdateProbeOutput) SetDestinationPort(v int64) *UpdateProbeOutput

SetDestinationPort sets the DestinationPort field's value.

func (*UpdateProbeOutput) SetModifiedAt

func (s *UpdateProbeOutput) SetModifiedAt(v time.Time) *UpdateProbeOutput

SetModifiedAt sets the ModifiedAt field's value.

func (*UpdateProbeOutput) SetPacketSize

func (s *UpdateProbeOutput) SetPacketSize(v int64) *UpdateProbeOutput

SetPacketSize sets the PacketSize field's value.

func (*UpdateProbeOutput) SetProbeArn

func (s *UpdateProbeOutput) SetProbeArn(v string) *UpdateProbeOutput

SetProbeArn sets the ProbeArn field's value.

func (*UpdateProbeOutput) SetProbeId

func (s *UpdateProbeOutput) SetProbeId(v string) *UpdateProbeOutput

SetProbeId sets the ProbeId field's value.

func (*UpdateProbeOutput) SetProtocol

func (s *UpdateProbeOutput) SetProtocol(v string) *UpdateProbeOutput

SetProtocol sets the Protocol field's value.

func (*UpdateProbeOutput) SetSourceArn

func (s *UpdateProbeOutput) SetSourceArn(v string) *UpdateProbeOutput

SetSourceArn sets the SourceArn field's value.

func (*UpdateProbeOutput) SetState

func (s *UpdateProbeOutput) SetState(v string) *UpdateProbeOutput

SetState sets the State field's value.

func (*UpdateProbeOutput) SetTags

func (s *UpdateProbeOutput) SetTags(v map[string]*string) *UpdateProbeOutput

SetTags sets the Tags field's value.

func (*UpdateProbeOutput) SetVpcId

func (s *UpdateProbeOutput) SetVpcId(v string) *UpdateProbeOutput

SetVpcId sets the VpcId field's value.

func (UpdateProbeOutput) String

func (s UpdateProbeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationException

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

One of the parameters for the request is not valid.

func (*ValidationException) Code

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error

func (s *ValidationException) Error() string

func (ValidationException) GoString

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) Message

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Directories

Path Synopsis
Package networkmonitoriface provides an interface to enable mocking the Amazon CloudWatch Network Monitor service client for testing your code.
Package networkmonitoriface provides an interface to enable mocking the Amazon CloudWatch Network Monitor service client for testing your code.

Jump to

Keyboard shortcuts

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