package types

import "github.com/aws/aws-sdk-go-v2/service/shield/types"

Index

Types

type AccessDeniedException

type AccessDeniedException struct {
	Message *string
}

Exception that indicates the specified AttackId does not exist, or the requester does not have the appropriate permissions to access the AttackId.

func (*AccessDeniedException) Error

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage

func (e *AccessDeniedException) ErrorMessage() string

type AccessDeniedForDependencyException

type AccessDeniedForDependencyException struct {
	Message *string
}

In order to grant the necessary access to the DDoS Response Team (DRT), the user submitting the request must have the iam:PassRole permission. This error indicates the user did not have the appropriate permissions. For more information, see Granting a User Permissions to Pass a Role to an AWS Service (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html).

func (*AccessDeniedForDependencyException) Error

func (*AccessDeniedForDependencyException) ErrorCode

func (*AccessDeniedForDependencyException) ErrorFault

func (*AccessDeniedForDependencyException) ErrorMessage

func (e *AccessDeniedForDependencyException) ErrorMessage() string

type AttackDetail

type AttackDetail struct {

	// List of counters that describe the attack for the specified time period.
	AttackCounters []*SummarizedCounter

	// The unique identifier (ID) of the attack.
	AttackId *string

	// The array of AttackProperty objects.
	AttackProperties []*AttackProperty

	// The time the attack ended, in Unix time in seconds. For more information see
	// timestamp
	// (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types).
	EndTime *time.Time

	// List of mitigation actions taken for the attack.
	Mitigations []*Mitigation

	// The ARN (Amazon Resource Name) of the resource that was attacked.
	ResourceArn *string

	// The time the attack started, in Unix time in seconds. For more information see
	// timestamp
	// (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types).
	StartTime *time.Time

	// If applicable, additional detail about the resource being attacked, for example,
	// IP address or URL.
	SubResources []*SubResourceSummary
}

The details of a DDoS attack.

type AttackLayer

type AttackLayer string
const (
	AttackLayerNetwork     AttackLayer = "NETWORK"
	AttackLayerApplication AttackLayer = "APPLICATION"
)

Enum values for AttackLayer

type AttackProperty

type AttackProperty struct {

	// The type of distributed denial of service (DDoS) event that was observed.
	// NETWORK indicates layer 3 and layer 4 events and APPLICATION indicates layer 7
	// events.
	AttackLayer AttackLayer

	// Defines the DDoS attack property information that is provided. The
	// WORDPRESS_PINGBACK_REFLECTOR and WORDPRESS_PINGBACK_SOURCE values are valid only
	// for WordPress reflective pingback DDoS attacks.
	AttackPropertyIdentifier AttackPropertyIdentifier

	// The array of Contributor objects that includes the top five contributors to an
	// attack.
	TopContributors []*Contributor

	// The total contributions made to this attack by all contributors, not just the
	// five listed in the TopContributors list.
	Total *int64

	// The unit of the Value of the contributions.
	Unit Unit
}

Details of the described attack.

type AttackPropertyIdentifier

type AttackPropertyIdentifier string
const (
	AttackPropertyIdentifierDestination_url              AttackPropertyIdentifier = "DESTINATION_URL"
	AttackPropertyIdentifierReferrer                     AttackPropertyIdentifier = "REFERRER"
	AttackPropertyIdentifierSource_asn                   AttackPropertyIdentifier = "SOURCE_ASN"
	AttackPropertyIdentifierSource_country               AttackPropertyIdentifier = "SOURCE_COUNTRY"
	AttackPropertyIdentifierSource_ip_address            AttackPropertyIdentifier = "SOURCE_IP_ADDRESS"
	AttackPropertyIdentifierSource_user_agent            AttackPropertyIdentifier = "SOURCE_USER_AGENT"
	AttackPropertyIdentifierWordpress_pingback_reflector AttackPropertyIdentifier = "WORDPRESS_PINGBACK_REFLECTOR"
	AttackPropertyIdentifierWordpress_pingback_source    AttackPropertyIdentifier = "WORDPRESS_PINGBACK_SOURCE"
)

Enum values for AttackPropertyIdentifier

type AttackSummary

type AttackSummary struct {

	// The unique identifier (ID) of the attack.
	AttackId *string

	// The list of attacks for a specified time period.
	AttackVectors []*AttackVectorDescription

	// The end time of the attack, in Unix time in seconds. For more information see
	// timestamp
	// (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types).
	EndTime *time.Time

	// The ARN (Amazon Resource Name) of the resource that was attacked.
	ResourceArn *string

	// The start time of the attack, in Unix time in seconds. For more information see
	// timestamp
	// (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types).
	StartTime *time.Time
}

Summarizes all DDoS attacks for a specified time period.

type AttackVectorDescription

type AttackVectorDescription struct {

	// The attack type. Valid values:
	//
	//     * UDP_TRAFFIC
	//
	//     * UDP_FRAGMENT
	//
	//     *
	// GENERIC_UDP_REFLECTION
	//
	//     * DNS_REFLECTION
	//
	//     * NTP_REFLECTION
	//
	//     *
	// CHARGEN_REFLECTION
	//
	//     * SSDP_REFLECTION
	//
	//     * PORT_MAPPER
	//
	//     *
	// RIP_REFLECTION
	//
	//     * SNMP_REFLECTION
	//
	//     * MSSQL_REFLECTION
	//
	//     *
	// NET_BIOS_REFLECTION
	//
	//     * SYN_FLOOD
	//
	//     * ACK_FLOOD
	//
	//     * REQUEST_FLOOD
	//
	//
	// * HTTP_REFLECTION
	//
	//     * UDS_REFLECTION
	//
	//     * MEMCACHED_REFLECTION
	//
	// This member is required.
	VectorType *string
}

Describes the attack.

type AutoRenew

type AutoRenew string
const (
	AutoRenewEnabled  AutoRenew = "ENABLED"
	AutoRenewDisabled AutoRenew = "DISABLED"
)

Enum values for AutoRenew

type Contributor

type Contributor struct {

	// The name of the contributor. This is dependent on the AttackPropertyIdentifier.
	// For example, if the AttackPropertyIdentifier is SOURCE_COUNTRY, the Name could
	// be United States.
	Name *string

	// The contribution of this contributor expressed in Protection units. For example
	// 10,000.
	Value *int64
}

A contributor to the attack and their contribution.

type EmergencyContact

type EmergencyContact struct {

	// The email address for the contact.
	//
	// This member is required.
	EmailAddress *string

	// Additional notes regarding the contact.
	ContactNotes *string

	// The phone number for the contact.
	PhoneNumber *string
}

Contact information that the DRT can use to contact you if you have proactive engagement enabled, for escalations to the DRT and to initiate proactive customer support.

type InternalErrorException

type InternalErrorException struct {
	Message *string
}

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

func (*InternalErrorException) Error

func (e *InternalErrorException) Error() string

func (*InternalErrorException) ErrorCode

func (e *InternalErrorException) ErrorCode() string

func (*InternalErrorException) ErrorFault

func (e *InternalErrorException) ErrorFault() smithy.ErrorFault

func (*InternalErrorException) ErrorMessage

func (e *InternalErrorException) ErrorMessage() string

type InvalidOperationException

type InvalidOperationException struct {
	Message *string
}

Exception that indicates that the operation would not cause any change to occur.

func (*InvalidOperationException) Error

func (e *InvalidOperationException) Error() string

func (*InvalidOperationException) ErrorCode

func (e *InvalidOperationException) ErrorCode() string

func (*InvalidOperationException) ErrorFault

func (*InvalidOperationException) ErrorMessage

func (e *InvalidOperationException) ErrorMessage() string

type InvalidPaginationTokenException

type InvalidPaginationTokenException struct {
	Message *string
}

Exception that indicates that the NextToken specified in the request is invalid. Submit the request using the NextToken value that was returned in the response.

func (*InvalidPaginationTokenException) Error

func (*InvalidPaginationTokenException) ErrorCode

func (e *InvalidPaginationTokenException) ErrorCode() string

func (*InvalidPaginationTokenException) ErrorFault

func (*InvalidPaginationTokenException) ErrorMessage

func (e *InvalidPaginationTokenException) ErrorMessage() string

type InvalidParameterException

type InvalidParameterException struct {
	Message *string
}

Exception that indicates that the parameters passed to the API are invalid.

func (*InvalidParameterException) Error

func (e *InvalidParameterException) Error() string

func (*InvalidParameterException) ErrorCode

func (e *InvalidParameterException) ErrorCode() string

func (*InvalidParameterException) ErrorFault

func (*InvalidParameterException) ErrorMessage

func (e *InvalidParameterException) ErrorMessage() string

type InvalidResourceException

type InvalidResourceException struct {
	Message *string
}

Exception that indicates that the resource is invalid. You might not have access to the resource, or the resource might not exist.

func (*InvalidResourceException) Error

func (e *InvalidResourceException) Error() string

func (*InvalidResourceException) ErrorCode

func (e *InvalidResourceException) ErrorCode() string

func (*InvalidResourceException) ErrorFault

func (e *InvalidResourceException) ErrorFault() smithy.ErrorFault

func (*InvalidResourceException) ErrorMessage

func (e *InvalidResourceException) ErrorMessage() string

type Limit

type Limit struct {

	// The maximum number of protections that can be created for the specified Type.
	Max *int64

	// The type of protection.
	Type *string
}

Specifies how many protections of a given type you can create.

type LimitsExceededException

type LimitsExceededException struct {
	Message *string

	Limit *int64
	Type  *string
}

Exception that indicates that the operation would exceed a limit. Type is the type of limit that would be exceeded. Limit is the threshold that would be exceeded.

func (*LimitsExceededException) Error

func (e *LimitsExceededException) Error() string

func (*LimitsExceededException) ErrorCode

func (e *LimitsExceededException) ErrorCode() string

func (*LimitsExceededException) ErrorFault

func (e *LimitsExceededException) ErrorFault() smithy.ErrorFault

func (*LimitsExceededException) ErrorMessage

func (e *LimitsExceededException) ErrorMessage() string

type LockedSubscriptionException

type LockedSubscriptionException struct {
	Message *string
}

You are trying to update a subscription that has not yet completed the 1-year commitment. You can change the AutoRenew parameter during the last 30 days of your subscription. This exception indicates that you are attempting to change AutoRenew prior to that period.

func (*LockedSubscriptionException) Error

func (*LockedSubscriptionException) ErrorCode

func (e *LockedSubscriptionException) ErrorCode() string

func (*LockedSubscriptionException) ErrorFault

func (*LockedSubscriptionException) ErrorMessage

func (e *LockedSubscriptionException) ErrorMessage() string

type Mitigation

type Mitigation struct {

	// The name of the mitigation taken for this attack.
	MitigationName *string
}

The mitigation applied to a DDoS attack.

type NoAssociatedRoleException

type NoAssociatedRoleException struct {
	Message *string
}

The ARN of the role that you specifed does not exist.

func (*NoAssociatedRoleException) Error

func (e *NoAssociatedRoleException) Error() string

func (*NoAssociatedRoleException) ErrorCode

func (e *NoAssociatedRoleException) ErrorCode() string

func (*NoAssociatedRoleException) ErrorFault

func (*NoAssociatedRoleException) ErrorMessage

func (e *NoAssociatedRoleException) ErrorMessage() string

type OptimisticLockException

type OptimisticLockException struct {
	Message *string
}

Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.

func (*OptimisticLockException) Error

func (e *OptimisticLockException) Error() string

func (*OptimisticLockException) ErrorCode

func (e *OptimisticLockException) ErrorCode() string

func (*OptimisticLockException) ErrorFault

func (e *OptimisticLockException) ErrorFault() smithy.ErrorFault

func (*OptimisticLockException) ErrorMessage

func (e *OptimisticLockException) ErrorMessage() string

type ProactiveEngagementStatus

type ProactiveEngagementStatus string
const (
	ProactiveEngagementStatusEnabled  ProactiveEngagementStatus = "ENABLED"
	ProactiveEngagementStatusDisabled ProactiveEngagementStatus = "DISABLED"
	ProactiveEngagementStatusPending  ProactiveEngagementStatus = "PENDING"
)

Enum values for ProactiveEngagementStatus

type Protection

type Protection struct {

	// The unique identifier (ID) for the Route 53 health check that's associated with
	// the protection.
	HealthCheckIds []*string

	// The unique identifier (ID) of the protection.
	Id *string

	// The friendly name of the protection. For example, My CloudFront distributions.
	Name *string

	// The ARN (Amazon Resource Name) of the AWS resource that is protected.
	ResourceArn *string
}

An object that represents a resource that is under DDoS protection.

type ResourceAlreadyExistsException

type ResourceAlreadyExistsException struct {
	Message *string
}

Exception indicating the specified resource already exists.

func (*ResourceAlreadyExistsException) Error

func (*ResourceAlreadyExistsException) ErrorCode

func (e *ResourceAlreadyExistsException) ErrorCode() string

func (*ResourceAlreadyExistsException) ErrorFault

func (*ResourceAlreadyExistsException) ErrorMessage

func (e *ResourceAlreadyExistsException) ErrorMessage() string

type ResourceNotFoundException

type ResourceNotFoundException struct {
	Message *string
}

Exception indicating the specified resource does not exist.

func (*ResourceNotFoundException) Error

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault

func (*ResourceNotFoundException) ErrorMessage

func (e *ResourceNotFoundException) ErrorMessage() string

type SubResourceSummary

type SubResourceSummary struct {

	// The list of attack types and associated counters.
	AttackVectors []*SummarizedAttackVector

	// The counters that describe the details of the attack.
	Counters []*SummarizedCounter

	// The unique identifier (ID) of the SubResource.
	Id *string

	// The SubResource type.
	Type SubResourceType
}

The attack information for the specified SubResource.

type SubResourceType

type SubResourceType string
const (
	SubResourceTypeIp  SubResourceType = "IP"
	SubResourceTypeUrl SubResourceType = "URL"
)

Enum values for SubResourceType

type Subscription

type Subscription struct {

	// If ENABLED, the subscription will be automatically renewed at the end of the
	// existing subscription period. When you initally create a subscription, AutoRenew
	// is set to ENABLED. You can change this by submitting an UpdateSubscription
	// request. If the UpdateSubscription request does not included a value for
	// AutoRenew, the existing value for AutoRenew remains unchanged.
	AutoRenew AutoRenew

	// The date and time your subscription will end.
	EndTime *time.Time

	// Specifies how many protections of a given type you can create.
	Limits []*Limit

	// If ENABLED, the DDoS Response Team (DRT) will use email and phone to notify
	// contacts about escalations to the DRT and to initiate proactive customer
	// support. If PENDING, you have requested proactive engagement and the request is
	// pending. The status changes to ENABLED when your request is fully processed. If
	// DISABLED, the DRT will not proactively notify contacts about escalations or to
	// initiate proactive customer support.
	ProactiveEngagementStatus ProactiveEngagementStatus

	// The start time of the subscription, in Unix time in seconds. For more
	// information see timestamp
	// (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types).
	StartTime *time.Time

	// The length, in seconds, of the AWS Shield Advanced subscription for the account.
	TimeCommitmentInSeconds *int64
}

Information about the AWS Shield Advanced subscription for an account.

type SubscriptionState

type SubscriptionState string
const (
	SubscriptionStateActive   SubscriptionState = "ACTIVE"
	SubscriptionStateInactive SubscriptionState = "INACTIVE"
)

Enum values for SubscriptionState

type SummarizedAttackVector

type SummarizedAttackVector struct {

	// The attack type, for example, SNMP reflection or SYN flood.
	//
	// This member is required.
	VectorType *string

	// The list of counters that describe the details of the attack.
	VectorCounters []*SummarizedCounter
}

A summary of information about the attack.

type SummarizedCounter

type SummarizedCounter struct {

	// The average value of the counter for a specified time period.
	Average *float64

	// The maximum value of the counter for a specified time period.
	Max *float64

	// The number of counters for a specified time period.
	N *int32

	// The counter name.
	Name *string

	// The total of counter values for a specified time period.
	Sum *float64

	// The unit of the counters.
	Unit *string
}

The counter that describes a DDoS attack.

type TimeRange

type TimeRange struct {

	// The start time, in Unix time in seconds. For more information see timestamp
	// (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types).
	FromInclusive *time.Time

	// The end time, in Unix time in seconds. For more information see timestamp
	// (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types).
	ToExclusive *time.Time
}

The time range.

type Unit

type Unit string
const (
	UnitBits     Unit = "BITS"
	UnitBytes    Unit = "BYTES"
	UnitPackets  Unit = "PACKETS"
	UnitRequests Unit = "REQUESTS"
)

Enum values for Unit

Source Files

enums.go errors.go types.go

Version
v0.27.0
Published
Oct 17, 2020
Platform
windows/amd64
Imports
3 packages
Last checked
7 seconds ago

Tools for package owners.