shield

package
v1.38.50 Latest Latest
Warning

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

 Go to latest Published: May 27, 2021 License: Apache-2.0 Imports: 10 Imported by: 61

Documentation

Overview

Package shield provides the client and types for making API requests to AWS Shield.

This is the AWS Shield Advanced API Reference. This guide is for developers who need detailed information about the AWS Shield Advanced API actions, data types, and errors. For detailed information about AWS WAF and AWS Shield Advanced features and an overview of how to use the AWS WAF and AWS Shield Advanced APIs, see the AWS WAF and AWS Shield Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/).

See https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02 for more information on this service.

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

Using the Client

To contact AWS Shield 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 AWS Shield client Shield for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/shield/#New

Index

Constants

View Source 
const (
	// AttackLayerNetwork is a AttackLayer enum value
	AttackLayerNetwork = "NETWORK"

	// AttackLayerApplication is a AttackLayer enum value
	AttackLayerApplication = "APPLICATION"
)
View Source 
const (
	// AttackPropertyIdentifierDestinationUrl is a AttackPropertyIdentifier enum value
	AttackPropertyIdentifierDestinationUrl = "DESTINATION_URL"

	// AttackPropertyIdentifierReferrer is a AttackPropertyIdentifier enum value
	AttackPropertyIdentifierReferrer = "REFERRER"

	// AttackPropertyIdentifierSourceAsn is a AttackPropertyIdentifier enum value
	AttackPropertyIdentifierSourceAsn = "SOURCE_ASN"

	// AttackPropertyIdentifierSourceCountry is a AttackPropertyIdentifier enum value
	AttackPropertyIdentifierSourceCountry = "SOURCE_COUNTRY"

	// AttackPropertyIdentifierSourceIpAddress is a AttackPropertyIdentifier enum value
	AttackPropertyIdentifierSourceIpAddress = "SOURCE_IP_ADDRESS"

	// AttackPropertyIdentifierSourceUserAgent is a AttackPropertyIdentifier enum value
	AttackPropertyIdentifierSourceUserAgent = "SOURCE_USER_AGENT"

	// AttackPropertyIdentifierWordpressPingbackReflector is a AttackPropertyIdentifier enum value
	AttackPropertyIdentifierWordpressPingbackReflector = "WORDPRESS_PINGBACK_REFLECTOR"

	// AttackPropertyIdentifierWordpressPingbackSource is a AttackPropertyIdentifier enum value
	AttackPropertyIdentifierWordpressPingbackSource = "WORDPRESS_PINGBACK_SOURCE"
)
View Source 
const (
	// AutoRenewEnabled is a AutoRenew enum value
	AutoRenewEnabled = "ENABLED"

	// AutoRenewDisabled is a AutoRenew enum value
	AutoRenewDisabled = "DISABLED"
)
View Source 
const (
	// ProactiveEngagementStatusEnabled is a ProactiveEngagementStatus enum value
	ProactiveEngagementStatusEnabled = "ENABLED"

	// ProactiveEngagementStatusDisabled is a ProactiveEngagementStatus enum value
	ProactiveEngagementStatusDisabled = "DISABLED"

	// ProactiveEngagementStatusPending is a ProactiveEngagementStatus enum value
	ProactiveEngagementStatusPending = "PENDING"
)
View Source 
const (
	// ProtectedResourceTypeCloudfrontDistribution is a ProtectedResourceType enum value
	ProtectedResourceTypeCloudfrontDistribution = "CLOUDFRONT_DISTRIBUTION"

	// ProtectedResourceTypeRoute53HostedZone is a ProtectedResourceType enum value
	ProtectedResourceTypeRoute53HostedZone = "ROUTE_53_HOSTED_ZONE"

	// ProtectedResourceTypeElasticIpAllocation is a ProtectedResourceType enum value
	ProtectedResourceTypeElasticIpAllocation = "ELASTIC_IP_ALLOCATION"

	// ProtectedResourceTypeClassicLoadBalancer is a ProtectedResourceType enum value
	ProtectedResourceTypeClassicLoadBalancer = "CLASSIC_LOAD_BALANCER"

	// ProtectedResourceTypeApplicationLoadBalancer is a ProtectedResourceType enum value
	ProtectedResourceTypeApplicationLoadBalancer = "APPLICATION_LOAD_BALANCER"

	// ProtectedResourceTypeGlobalAccelerator is a ProtectedResourceType enum value
	ProtectedResourceTypeGlobalAccelerator = "GLOBAL_ACCELERATOR"
)
View Source 
const (
	// ProtectionGroupAggregationSum is a ProtectionGroupAggregation enum value
	ProtectionGroupAggregationSum = "SUM"

	// ProtectionGroupAggregationMean is a ProtectionGroupAggregation enum value
	ProtectionGroupAggregationMean = "MEAN"

	// ProtectionGroupAggregationMax is a ProtectionGroupAggregation enum value
	ProtectionGroupAggregationMax = "MAX"
)
View Source 
const (
	// ProtectionGroupPatternAll is a ProtectionGroupPattern enum value
	ProtectionGroupPatternAll = "ALL"

	// ProtectionGroupPatternArbitrary is a ProtectionGroupPattern enum value
	ProtectionGroupPatternArbitrary = "ARBITRARY"

	// ProtectionGroupPatternByResourceType is a ProtectionGroupPattern enum value
	ProtectionGroupPatternByResourceType = "BY_RESOURCE_TYPE"
)
View Source 
const (
	// SubResourceTypeIp is a SubResourceType enum value
	SubResourceTypeIp = "IP"

	// SubResourceTypeUrl is a SubResourceType enum value
	SubResourceTypeUrl = "URL"
)
View Source 
const (
	// SubscriptionStateActive is a SubscriptionState enum value
	SubscriptionStateActive = "ACTIVE"

	// SubscriptionStateInactive is a SubscriptionState enum value
	SubscriptionStateInactive = "INACTIVE"
)
View Source 
const (
	// UnitBits is a Unit enum value
	UnitBits = "BITS"

	// UnitBytes is a Unit enum value
	UnitBytes = "BYTES"

	// UnitPackets is a Unit enum value
	UnitPackets = "PACKETS"

	// UnitRequests is a Unit enum value
	UnitRequests = "REQUESTS"
)
View Source 
const (
	// ValidationExceptionReasonFieldValidationFailed is a ValidationExceptionReason enum value
	ValidationExceptionReasonFieldValidationFailed = "FIELD_VALIDATION_FAILED"

	// ValidationExceptionReasonOther is a ValidationExceptionReason enum value
	ValidationExceptionReasonOther = "OTHER"
)
View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// Exception that indicates the specified AttackId does not exist, or the requester
	// does not have the appropriate permissions to access the AttackId.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeAccessDeniedForDependencyException for service response error code
	// "AccessDeniedForDependencyException".
	//
	// 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).
	ErrCodeAccessDeniedForDependencyException = "AccessDeniedForDependencyException"

	// ErrCodeInternalErrorException for service response error code
	// "InternalErrorException".
	//
	// Exception that indicates that a problem occurred with the service infrastructure.
	// You can retry the request.
	ErrCodeInternalErrorException = "InternalErrorException"

	// ErrCodeInvalidOperationException for service response error code
	// "InvalidOperationException".
	//
	// Exception that indicates that the operation would not cause any change to
	// occur.
	ErrCodeInvalidOperationException = "InvalidOperationException"

	// ErrCodeInvalidPaginationTokenException for service response error code
	// "InvalidPaginationTokenException".
	//
	// 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.
	ErrCodeInvalidPaginationTokenException = "InvalidPaginationTokenException"

	// ErrCodeInvalidParameterException for service response error code
	// "InvalidParameterException".
	//
	// Exception that indicates that the parameters passed to the API are invalid.
	// If available, this exception includes details in additional properties.
	ErrCodeInvalidParameterException = "InvalidParameterException"

	// ErrCodeInvalidResourceException for service response error code
	// "InvalidResourceException".
	//
	// Exception that indicates that the resource is invalid. You might not have
	// access to the resource, or the resource might not exist.
	ErrCodeInvalidResourceException = "InvalidResourceException"

	// ErrCodeLimitsExceededException for service response error code
	// "LimitsExceededException".
	//
	// Exception that indicates that the operation would exceed a limit.
	ErrCodeLimitsExceededException = "LimitsExceededException"

	// ErrCodeLockedSubscriptionException for service response error code
	// "LockedSubscriptionException".
	//
	// 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.
	ErrCodeLockedSubscriptionException = "LockedSubscriptionException"

	// ErrCodeNoAssociatedRoleException for service response error code
	// "NoAssociatedRoleException".
	//
	// The ARN of the role that you specifed does not exist.
	ErrCodeNoAssociatedRoleException = "NoAssociatedRoleException"

	// ErrCodeOptimisticLockException for service response error code
	// "OptimisticLockException".
	//
	// Exception that indicates that the resource state has been modified by another
	// client. Retrieve the resource and then retry your request.
	ErrCodeOptimisticLockException = "OptimisticLockException"

	// ErrCodeResourceAlreadyExistsException for service response error code
	// "ResourceAlreadyExistsException".
	//
	// Exception indicating the specified resource already exists. If available,
	// this exception includes details in additional properties.
	ErrCodeResourceAlreadyExistsException = "ResourceAlreadyExistsException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// Exception indicating the specified resource does not exist. If available,
	// this exception includes details in additional properties.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"
)
View Source 
const (
	ServiceName = "shield"    // Name of service.
	EndpointsID = ServiceName // ID to lookup a service endpoint with.
	ServiceID   = "Shield"    // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func AttackLayer_Values added in v1.34.3 

func AttackLayer_Values() []string

AttackLayer_Values returns all elements of the AttackLayer enum

func AttackPropertyIdentifier_Values added in v1.34.3 

func AttackPropertyIdentifier_Values() []string

AttackPropertyIdentifier_Values returns all elements of the AttackPropertyIdentifier enum

func AutoRenew_Values added in v1.34.3 

func AutoRenew_Values() []string

AutoRenew_Values returns all elements of the AutoRenew enum

func ProactiveEngagementStatus_Values added in v1.34.3 

func ProactiveEngagementStatus_Values() []string

ProactiveEngagementStatus_Values returns all elements of the ProactiveEngagementStatus enum

func ProtectedResourceType_Values added in v1.35.28 

func ProtectedResourceType_Values() []string

ProtectedResourceType_Values returns all elements of the ProtectedResourceType enum

func ProtectionGroupAggregation_Values added in v1.35.28 

func ProtectionGroupAggregation_Values() []string

ProtectionGroupAggregation_Values returns all elements of the ProtectionGroupAggregation enum

func ProtectionGroupPattern_Values added in v1.35.28 

func ProtectionGroupPattern_Values() []string

ProtectionGroupPattern_Values returns all elements of the ProtectionGroupPattern enum

func SubResourceType_Values added in v1.34.3 

func SubResourceType_Values() []string

SubResourceType_Values returns all elements of the SubResourceType enum

func SubscriptionState_Values added in v1.34.3 

func SubscriptionState_Values() []string

SubscriptionState_Values returns all elements of the SubscriptionState enum

func Unit_Values added in v1.34.3 

func Unit_Values() []string

Unit_Values returns all elements of the Unit enum

func ValidationExceptionReason_Values added in v1.35.28 

func ValidationExceptionReason_Values() []string

ValidationExceptionReason_Values returns all elements of the ValidationExceptionReason enum

Types

type AccessDeniedException added in v1.28.0 

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

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

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

func (*AccessDeniedException) Code added in v1.28.0 

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error added in v1.28.0 

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString added in v1.28.0 

func (s AccessDeniedException) GoString() string

GoString returns the string representation

func (*AccessDeniedException) Message added in v1.28.0 

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr added in v1.28.0 

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID added in v1.28.0 

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode added in v1.28.0 

func (s *AccessDeniedException) StatusCode() int

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

func (AccessDeniedException) String added in v1.28.0 

func (s AccessDeniedException) String() string

String returns the string representation

type AccessDeniedForDependencyException added in v1.28.0 

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

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

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) Code added in v1.28.0 

func (s *AccessDeniedForDependencyException) Code() string

Code returns the exception type name.

func (*AccessDeniedForDependencyException) Error added in v1.28.0 

func (s *AccessDeniedForDependencyException) Error() string

func (AccessDeniedForDependencyException) GoString added in v1.28.0 

func (s AccessDeniedForDependencyException) GoString() string

GoString returns the string representation

func (*AccessDeniedForDependencyException) Message added in v1.28.0 

func (s *AccessDeniedForDependencyException) Message() string

Message returns the exception's message.

func (*AccessDeniedForDependencyException) OrigErr added in v1.28.0 

func (s *AccessDeniedForDependencyException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedForDependencyException) RequestID added in v1.28.0 

func (s *AccessDeniedForDependencyException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedForDependencyException) StatusCode added in v1.28.0 

func (s *AccessDeniedForDependencyException) StatusCode() int

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

func (AccessDeniedForDependencyException) String added in v1.28.0 

func (s AccessDeniedForDependencyException) String() string

String returns the string representation

type AssociateDRTLogBucketInput added in v1.14.1 

type AssociateDRTLogBucketInput struct {

	// The Amazon S3 bucket that contains your AWS WAF logs.
	//
	// LogBucket is a required field
	LogBucket *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AssociateDRTLogBucketInput) GoString added in v1.14.1 

func (s AssociateDRTLogBucketInput) GoString() string

GoString returns the string representation

func (*AssociateDRTLogBucketInput) SetLogBucket added in v1.14.1 

func (s *AssociateDRTLogBucketInput) SetLogBucket(v string) *AssociateDRTLogBucketInput

SetLogBucket sets the LogBucket field's value.

func (AssociateDRTLogBucketInput) String added in v1.14.1 

func (s AssociateDRTLogBucketInput) String() string

String returns the string representation

func (*AssociateDRTLogBucketInput) Validate added in v1.14.1 

func (s *AssociateDRTLogBucketInput) Validate() error

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

type AssociateDRTLogBucketOutput added in v1.14.1 

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

func (AssociateDRTLogBucketOutput) GoString added in v1.14.1 

func (s AssociateDRTLogBucketOutput) GoString() string

GoString returns the string representation

func (AssociateDRTLogBucketOutput) String added in v1.14.1 

func (s AssociateDRTLogBucketOutput) String() string

String returns the string representation

type AssociateDRTRoleInput added in v1.14.1 

type AssociateDRTRoleInput struct {

	// The Amazon Resource Name (ARN) of the role the DRT will use to access your
	// AWS account.
	//
	// Prior to making the AssociateDRTRole request, you must attach the AWSShieldDRTAccessPolicy
	// (https://console.aws.amazon.com/iam/home?#/policies/arn:aws:iam::aws:policy/service-role/AWSShieldDRTAccessPolicy)
	// managed policy to this role. For more information see Attaching and Detaching
	// IAM Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_manage-attach-detach.html).
	//
	// RoleArn is a required field
	RoleArn *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AssociateDRTRoleInput) GoString added in v1.14.1 

func (s AssociateDRTRoleInput) GoString() string

GoString returns the string representation

func (*AssociateDRTRoleInput) SetRoleArn added in v1.14.1 

func (s *AssociateDRTRoleInput) SetRoleArn(v string) *AssociateDRTRoleInput

SetRoleArn sets the RoleArn field's value.

func (AssociateDRTRoleInput) String added in v1.14.1 

func (s AssociateDRTRoleInput) String() string

String returns the string representation

func (*AssociateDRTRoleInput) Validate added in v1.14.1 

func (s *AssociateDRTRoleInput) Validate() error

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

type AssociateDRTRoleOutput added in v1.14.1 

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

func (AssociateDRTRoleOutput) GoString added in v1.14.1 

func (s AssociateDRTRoleOutput) GoString() string

GoString returns the string representation

func (AssociateDRTRoleOutput) String added in v1.14.1 

func (s AssociateDRTRoleOutput) String() string

String returns the string representation

type AssociateHealthCheckInput added in v1.29.3 

type AssociateHealthCheckInput struct {

	// The Amazon Resource Name (ARN) of the health check to associate with the
	// protection.
	//
	// HealthCheckArn is a required field
	HealthCheckArn *string `min:"1" type:"string" required:"true"`

	// The unique identifier (ID) for the Protection object to add the health check
	// association to.
	//
	// ProtectionId is a required field
	ProtectionId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AssociateHealthCheckInput) GoString added in v1.29.3 

func (s AssociateHealthCheckInput) GoString() string

GoString returns the string representation

func (*AssociateHealthCheckInput) SetHealthCheckArn added in v1.29.3 

func (s *AssociateHealthCheckInput) SetHealthCheckArn(v string) *AssociateHealthCheckInput

SetHealthCheckArn sets the HealthCheckArn field's value.

func (*AssociateHealthCheckInput) SetProtectionId added in v1.29.3 

func (s *AssociateHealthCheckInput) SetProtectionId(v string) *AssociateHealthCheckInput

SetProtectionId sets the ProtectionId field's value.

func (AssociateHealthCheckInput) String added in v1.29.3 

func (s AssociateHealthCheckInput) String() string

String returns the string representation

func (*AssociateHealthCheckInput) Validate added in v1.29.3 

func (s *AssociateHealthCheckInput) Validate() error

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

type AssociateHealthCheckOutput added in v1.29.3 

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

func (AssociateHealthCheckOutput) GoString added in v1.29.3 

func (s AssociateHealthCheckOutput) GoString() string

GoString returns the string representation

func (AssociateHealthCheckOutput) String added in v1.29.3 

func (s AssociateHealthCheckOutput) String() string

String returns the string representation

type AssociateProactiveEngagementDetailsInput added in v1.31.13 

type AssociateProactiveEngagementDetailsInput struct {

	// A list of email addresses and phone numbers that the DDoS Response Team (DRT)
	// can use to contact you for escalations to the DRT and to initiate proactive
	// customer support.
	//
	// To enable proactive engagement, the contact list must include at least one
	// phone number.
	//
	// The contacts that you provide here replace any contacts that were already
	// defined. If you already have contacts defined and want to use them, retrieve
	// the list using DescribeEmergencyContactSettings and then provide it here.
	//
	// EmergencyContactList is a required field
	EmergencyContactList []*EmergencyContact `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (AssociateProactiveEngagementDetailsInput) GoString added in v1.31.13 

func (s AssociateProactiveEngagementDetailsInput) GoString() string

GoString returns the string representation

func (*AssociateProactiveEngagementDetailsInput) SetEmergencyContactList added in v1.31.13 

func (s *AssociateProactiveEngagementDetailsInput) SetEmergencyContactList(v []*EmergencyContact) *AssociateProactiveEngagementDetailsInput

SetEmergencyContactList sets the EmergencyContactList field's value.

func (AssociateProactiveEngagementDetailsInput) String added in v1.31.13 

func (s AssociateProactiveEngagementDetailsInput) String() string

String returns the string representation

func (*AssociateProactiveEngagementDetailsInput) Validate added in v1.31.13 

func (s *AssociateProactiveEngagementDetailsInput) Validate() error

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

type AssociateProactiveEngagementDetailsOutput added in v1.31.13 

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

func (AssociateProactiveEngagementDetailsOutput) GoString added in v1.31.13 

func (s AssociateProactiveEngagementDetailsOutput) GoString() string

GoString returns the string representation

func (AssociateProactiveEngagementDetailsOutput) String added in v1.31.13 

func (s AssociateProactiveEngagementDetailsOutput) String() string

String returns the string representation

type AttackDetail 

type AttackDetail struct {

	// List of counters that describe the attack for the specified time period.
	AttackCounters []*SummarizedCounter `type:"list"`

	// The unique identifier (ID) of the attack.
	AttackId *string `min:"1" type:"string"`

	// The array of AttackProperty objects.
	AttackProperties []*AttackProperty `type:"list"`

	// 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 `type:"timestamp"`

	// List of mitigation actions taken for the attack.
	Mitigations []*Mitigation `type:"list"`

	// The ARN (Amazon Resource Name) of the resource that was attacked.
	ResourceArn *string `min:"1" type:"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 `type:"timestamp"`

	// If applicable, additional detail about the resource being attacked, for example,
	// IP address or URL.
	SubResources []*SubResourceSummary `type:"list"`
	// contains filtered or unexported fields
}

The details of a DDoS attack.

func (AttackDetail) GoString 

func (s AttackDetail) GoString() string

GoString returns the string representation

func (*AttackDetail) SetAttackCounters 

func (s *AttackDetail) SetAttackCounters(v []*SummarizedCounter) *AttackDetail

SetAttackCounters sets the AttackCounters field's value.

func (*AttackDetail) SetAttackId 

func (s *AttackDetail) SetAttackId(v string) *AttackDetail

SetAttackId sets the AttackId field's value.

func (*AttackDetail) SetAttackProperties added in v1.12.32 

func (s *AttackDetail) SetAttackProperties(v []*AttackProperty) *AttackDetail

SetAttackProperties sets the AttackProperties field's value.

func (*AttackDetail) SetEndTime 

func (s *AttackDetail) SetEndTime(v time.Time) *AttackDetail

SetEndTime sets the EndTime field's value.

func (*AttackDetail) SetMitigations 

func (s *AttackDetail) SetMitigations(v []*Mitigation) *AttackDetail

SetMitigations sets the Mitigations field's value.

func (*AttackDetail) SetResourceArn 

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

SetResourceArn sets the ResourceArn field's value.

func (*AttackDetail) SetStartTime 

func (s *AttackDetail) SetStartTime(v time.Time) *AttackDetail

SetStartTime sets the StartTime field's value.

func (*AttackDetail) SetSubResources 

func (s *AttackDetail) SetSubResources(v []*SubResourceSummary) *AttackDetail

SetSubResources sets the SubResources field's value.

func (AttackDetail) String 

func (s AttackDetail) String() string

String returns the string representation

type AttackProperty added in v1.12.32 

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 *string `type:"string" enum:"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 *string `type:"string" enum:"AttackPropertyIdentifier"`

	// The array of contributor objects that includes the top five contributors
	// to an attack.
	TopContributors []*Contributor `type:"list"`

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

	// The unit of the Value of the contributions.
	Unit *string `type:"string" enum:"Unit"`
	// contains filtered or unexported fields
}

Details of the described attack.

func (AttackProperty) GoString added in v1.12.32 

func (s AttackProperty) GoString() string

GoString returns the string representation

func (*AttackProperty) SetAttackLayer added in v1.12.32 

func (s *AttackProperty) SetAttackLayer(v string) *AttackProperty

SetAttackLayer sets the AttackLayer field's value.

func (*AttackProperty) SetAttackPropertyIdentifier added in v1.12.32 

func (s *AttackProperty) SetAttackPropertyIdentifier(v string) *AttackProperty

SetAttackPropertyIdentifier sets the AttackPropertyIdentifier field's value.

func (*AttackProperty) SetTopContributors added in v1.12.32 

func (s *AttackProperty) SetTopContributors(v []*Contributor) *AttackProperty

SetTopContributors sets the TopContributors field's value.

func (*AttackProperty) SetTotal added in v1.12.32 

func (s *AttackProperty) SetTotal(v int64) *AttackProperty

SetTotal sets the Total field's value.

func (*AttackProperty) SetUnit added in v1.12.32 

func (s *AttackProperty) SetUnit(v string) *AttackProperty

SetUnit sets the Unit field's value.

func (AttackProperty) String added in v1.12.32 

func (s AttackProperty) String() string

String returns the string representation

type AttackStatisticsDataItem added in v1.35.28 

type AttackStatisticsDataItem struct {

	// The number of attacks detected during the time period. This is always present,
	// but might be zero.
	//
	// AttackCount is a required field
	AttackCount *int64 `type:"long" required:"true"`

	// Information about the volume of attacks during the time period. If the accompanying
	// AttackCount is zero, this setting might be empty.
	AttackVolume *AttackVolume `type:"structure"`
	// contains filtered or unexported fields
}

A single attack statistics data record. This is returned by DescribeAttackStatistics along with a time range indicating the time period that the attack statistics apply to.

func (AttackStatisticsDataItem) GoString added in v1.35.28 

func (s AttackStatisticsDataItem) GoString() string

GoString returns the string representation

func (*AttackStatisticsDataItem) SetAttackCount added in v1.35.28 

func (s *AttackStatisticsDataItem) SetAttackCount(v int64) *AttackStatisticsDataItem

SetAttackCount sets the AttackCount field's value.

func (*AttackStatisticsDataItem) SetAttackVolume added in v1.35.28 

func (s *AttackStatisticsDataItem) SetAttackVolume(v *AttackVolume) *AttackStatisticsDataItem

SetAttackVolume sets the AttackVolume field's value.

func (AttackStatisticsDataItem) String added in v1.35.28 

func (s AttackStatisticsDataItem) String() string

String returns the string representation

type AttackSummary 

type AttackSummary struct {

	// The unique identifier (ID) of the attack.
	AttackId *string `type:"string"`

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

	// 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 `type:"timestamp"`

	// The ARN (Amazon Resource Name) of the resource that was attacked.
	ResourceArn *string `type:"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 `type:"timestamp"`
	// contains filtered or unexported fields
}

Summarizes all DDoS attacks for a specified time period.

func (AttackSummary) GoString 

func (s AttackSummary) GoString() string

GoString returns the string representation

func (*AttackSummary) SetAttackId 

func (s *AttackSummary) SetAttackId(v string) *AttackSummary

SetAttackId sets the AttackId field's value.

func (*AttackSummary) SetAttackVectors 

func (s *AttackSummary) SetAttackVectors(v []*AttackVectorDescription) *AttackSummary

SetAttackVectors sets the AttackVectors field's value.

func (*AttackSummary) SetEndTime 

func (s *AttackSummary) SetEndTime(v time.Time) *AttackSummary

SetEndTime sets the EndTime field's value.

func (*AttackSummary) SetResourceArn 

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

SetResourceArn sets the ResourceArn field's value.

func (*AttackSummary) SetStartTime 

func (s *AttackSummary) SetStartTime(v time.Time) *AttackSummary

SetStartTime sets the StartTime field's value.

func (AttackSummary) String 

func (s AttackSummary) String() string

String returns the string representation

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
	//
	// VectorType is a required field
	VectorType *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes the attack.

func (AttackVectorDescription) GoString 

func (s AttackVectorDescription) GoString() string

GoString returns the string representation

func (*AttackVectorDescription) SetVectorType 

func (s *AttackVectorDescription) SetVectorType(v string) *AttackVectorDescription

SetVectorType sets the VectorType field's value.

func (AttackVectorDescription) String 

func (s AttackVectorDescription) String() string

String returns the string representation

type AttackVolume added in v1.35.28 

type AttackVolume struct {

	// A statistics object that uses bits per second as the unit. This is included
	// for network level attacks.
	BitsPerSecond *AttackVolumeStatistics `type:"structure"`

	// A statistics object that uses packets per second as the unit. This is included
	// for network level attacks.
	PacketsPerSecond *AttackVolumeStatistics `type:"structure"`

	// A statistics object that uses requests per second as the unit. This is included
	// for application level attacks, and is only available for accounts that are
	// subscribed to Shield Advanced.
	RequestsPerSecond *AttackVolumeStatistics `type:"structure"`
	// contains filtered or unexported fields
}

Information about the volume of attacks during the time period, included in an AttackStatisticsDataItem. If the accompanying AttackCount in the statistics object is zero, this setting might be empty.

func (AttackVolume) GoString added in v1.35.28 

func (s AttackVolume) GoString() string

GoString returns the string representation

func (*AttackVolume) SetBitsPerSecond added in v1.35.28 

func (s *AttackVolume) SetBitsPerSecond(v *AttackVolumeStatistics) *AttackVolume

SetBitsPerSecond sets the BitsPerSecond field's value.

func (*AttackVolume) SetPacketsPerSecond added in v1.35.28 

func (s *AttackVolume) SetPacketsPerSecond(v *AttackVolumeStatistics) *AttackVolume

SetPacketsPerSecond sets the PacketsPerSecond field's value.

func (*AttackVolume) SetRequestsPerSecond added in v1.35.28 

func (s *AttackVolume) SetRequestsPerSecond(v *AttackVolumeStatistics) *AttackVolume

SetRequestsPerSecond sets the RequestsPerSecond field's value.

func (AttackVolume) String added in v1.35.28 

func (s AttackVolume) String() string

String returns the string representation

type AttackVolumeStatistics added in v1.35.28 

type AttackVolumeStatistics struct {

	// The maximum attack volume observed for the given unit.
	//
	// Max is a required field
	Max *float64 `type:"double" required:"true"`
	// contains filtered or unexported fields
}

Statistics objects for the various data types in AttackVolume.

func (AttackVolumeStatistics) GoString added in v1.35.28 

func (s AttackVolumeStatistics) GoString() string

GoString returns the string representation

func (*AttackVolumeStatistics) SetMax added in v1.35.28 

func (s *AttackVolumeStatistics) SetMax(v float64) *AttackVolumeStatistics

SetMax sets the Max field's value.

func (AttackVolumeStatistics) String added in v1.35.28 

func (s AttackVolumeStatistics) String() string

String returns the string representation

type Contributor added in v1.12.32 

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 `type:"string"`

	// The contribution of this contributor expressed in Protection units. For example
	// 10,000.
	Value *int64 `type:"long"`
	// contains filtered or unexported fields
}

A contributor to the attack and their contribution.

func (Contributor) GoString added in v1.12.32 

func (s Contributor) GoString() string

GoString returns the string representation

func (*Contributor) SetName added in v1.12.32 

func (s *Contributor) SetName(v string) *Contributor

SetName sets the Name field's value.

func (*Contributor) SetValue added in v1.12.32 

func (s *Contributor) SetValue(v int64) *Contributor

SetValue sets the Value field's value.

func (Contributor) String added in v1.12.32 

func (s Contributor) String() string

String returns the string representation

type CreateProtectionGroupInput added in v1.35.28 

type CreateProtectionGroupInput struct {

	// Defines how AWS Shield combines resource data for the group in order to detect,
	// mitigate, and report events.
	//
	//    * Sum - Use the total traffic across the group. This is a good choice
	//    for most cases. Examples include Elastic IP addresses for EC2 instances
	//    that scale manually or automatically.
	//
	//    * Mean - Use the average of the traffic across the group. This is a good
	//    choice for resources that share traffic uniformly. Examples include accelerators
	//    and load balancers.
	//
	//    * Max - Use the highest traffic from each resource. This is useful for
	//    resources that don't share traffic and for resources that share that traffic
	//    in a non-uniform way. Examples include CloudFront distributions and origin
	//    resources for CloudFront distributions.
	//
	// Aggregation is a required field
	Aggregation *string `type:"string" required:"true" enum:"ProtectionGroupAggregation"`

	// The Amazon Resource Names (ARNs) of the resources to include in the protection
	// group. You must set this when you set Pattern to ARBITRARY and you must not
	// set it for any other Pattern setting.
	Members []*string `type:"list"`

	// The criteria to use to choose the protected resources for inclusion in the
	// group. You can include all resources that have protections, provide a list
	// of resource Amazon Resource Names (ARNs), or include all resources of a specified
	// resource type.
	//
	// Pattern is a required field
	Pattern *string `type:"string" required:"true" enum:"ProtectionGroupPattern"`

	// The name of the protection group. You use this to identify the protection
	// group in lists and to manage the protection group, for example to update,
	// delete, or describe it.
	//
	// ProtectionGroupId is a required field
	ProtectionGroupId *string `min:"1" type:"string" required:"true"`

	// The resource type to include in the protection group. All protected resources
	// of this type are included in the protection group. Newly protected resources
	// of this type are automatically added to the group. You must set this when
	// you set Pattern to BY_RESOURCE_TYPE and you must not set it for any other
	// Pattern setting.
	ResourceType *string `type:"string" enum:"ProtectedResourceType"`

	// One or more tag key-value pairs for the protection group.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateProtectionGroupInput) GoString added in v1.35.28 

func (s CreateProtectionGroupInput) GoString() string

GoString returns the string representation

func (*CreateProtectionGroupInput) SetAggregation added in v1.35.28 

func (s *CreateProtectionGroupInput) SetAggregation(v string) *CreateProtectionGroupInput

SetAggregation sets the Aggregation field's value.

func (*CreateProtectionGroupInput) SetMembers added in v1.35.28 

func (s *CreateProtectionGroupInput) SetMembers(v []*string) *CreateProtectionGroupInput

SetMembers sets the Members field's value.

func (*CreateProtectionGroupInput) SetPattern added in v1.35.28 

func (s *CreateProtectionGroupInput) SetPattern(v string) *CreateProtectionGroupInput

SetPattern sets the Pattern field's value.

func (*CreateProtectionGroupInput) SetProtectionGroupId added in v1.35.28 

func (s *CreateProtectionGroupInput) SetProtectionGroupId(v string) *CreateProtectionGroupInput

SetProtectionGroupId sets the ProtectionGroupId field's value.

func (*CreateProtectionGroupInput) SetResourceType added in v1.35.28 

func (s *CreateProtectionGroupInput) SetResourceType(v string) *CreateProtectionGroupInput

SetResourceType sets the ResourceType field's value.

func (*CreateProtectionGroupInput) SetTags added in v1.37.25 

func (s *CreateProtectionGroupInput) SetTags(v []*Tag) *CreateProtectionGroupInput

SetTags sets the Tags field's value.

func (CreateProtectionGroupInput) String added in v1.35.28 

func (s CreateProtectionGroupInput) String() string

String returns the string representation

func (*CreateProtectionGroupInput) Validate added in v1.35.28 

func (s *CreateProtectionGroupInput) Validate() error

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

type CreateProtectionGroupOutput added in v1.35.28 

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

func (CreateProtectionGroupOutput) GoString added in v1.35.28 

func (s CreateProtectionGroupOutput) GoString() string

GoString returns the string representation

func (CreateProtectionGroupOutput) String added in v1.35.28 

func (s CreateProtectionGroupOutput) String() string

String returns the string representation

type CreateProtectionInput 

type CreateProtectionInput struct {

	// Friendly name for the Protection you are creating.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The ARN (Amazon Resource Name) of the resource to be protected.
	//
	// The ARN should be in one of the following formats:
	//
	//    * For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
	//
	//    * For an Elastic Load Balancer (Classic Load Balancer): arn:aws:elasticloadbalancing:region:account-id:loadbalancer/load-balancer-name
	//
	//    * For an AWS CloudFront distribution: arn:aws:cloudfront::account-id:distribution/distribution-id
	//
	//    * For an AWS Global Accelerator accelerator: arn:aws:globalaccelerator::account-id:accelerator/accelerator-id
	//
	//    * For Amazon Route 53: arn:aws:route53:::hostedzone/hosted-zone-id
	//
	//    * For an Elastic IP address: arn:aws:ec2:region:account-id:eip-allocation/allocation-id
	//
	// ResourceArn is a required field
	ResourceArn *string `min:"1" type:"string" required:"true"`

	// One or more tag key-value pairs for the Protection object that is created.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateProtectionInput) GoString 

func (s CreateProtectionInput) GoString() string

GoString returns the string representation

func (*CreateProtectionInput) SetName 

func (s *CreateProtectionInput) SetName(v string) *CreateProtectionInput

SetName sets the Name field's value.

func (*CreateProtectionInput) SetResourceArn 

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

SetResourceArn sets the ResourceArn field's value.

func (*CreateProtectionInput) SetTags added in v1.37.25 

func (s *CreateProtectionInput) SetTags(v []*Tag) *CreateProtectionInput

SetTags sets the Tags field's value.

func (CreateProtectionInput) String 

func (s CreateProtectionInput) String() string

String returns the string representation

func (*CreateProtectionInput) Validate 

func (s *CreateProtectionInput) Validate() error

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

type CreateProtectionOutput 

type CreateProtectionOutput struct {

	// The unique identifier (ID) for the Protection object that is created.
	ProtectionId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateProtectionOutput) GoString 

func (s CreateProtectionOutput) GoString() string

GoString returns the string representation

func (*CreateProtectionOutput) SetProtectionId 

func (s *CreateProtectionOutput) SetProtectionId(v string) *CreateProtectionOutput

SetProtectionId sets the ProtectionId field's value.

func (CreateProtectionOutput) String 

func (s CreateProtectionOutput) String() string

String returns the string representation

type CreateSubscriptionInput 

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

func (CreateSubscriptionInput) GoString 

func (s CreateSubscriptionInput) GoString() string

GoString returns the string representation

func (CreateSubscriptionInput) String 

func (s CreateSubscriptionInput) String() string

String returns the string representation

type CreateSubscriptionOutput 

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

func (CreateSubscriptionOutput) GoString 

func (s CreateSubscriptionOutput) GoString() string

GoString returns the string representation

func (CreateSubscriptionOutput) String 

func (s CreateSubscriptionOutput) String() string

String returns the string representation

type DeleteProtectionGroupInput added in v1.35.28 

type DeleteProtectionGroupInput struct {

	// The name of the protection group. You use this to identify the protection
	// group in lists and to manage the protection group, for example to update,
	// delete, or describe it.
	//
	// ProtectionGroupId is a required field
	ProtectionGroupId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteProtectionGroupInput) GoString added in v1.35.28 

func (s DeleteProtectionGroupInput) GoString() string

GoString returns the string representation

func (*DeleteProtectionGroupInput) SetProtectionGroupId added in v1.35.28 

func (s *DeleteProtectionGroupInput) SetProtectionGroupId(v string) *DeleteProtectionGroupInput

SetProtectionGroupId sets the ProtectionGroupId field's value.

func (DeleteProtectionGroupInput) String added in v1.35.28 

func (s DeleteProtectionGroupInput) String() string

String returns the string representation

func (*DeleteProtectionGroupInput) Validate added in v1.35.28 

func (s *DeleteProtectionGroupInput) Validate() error

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

type DeleteProtectionGroupOutput added in v1.35.28 

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

func (DeleteProtectionGroupOutput) GoString added in v1.35.28 

func (s DeleteProtectionGroupOutput) GoString() string

GoString returns the string representation

func (DeleteProtectionGroupOutput) String added in v1.35.28 

func (s DeleteProtectionGroupOutput) String() string

String returns the string representation

type DeleteProtectionInput 

type DeleteProtectionInput struct {

	// The unique identifier (ID) for the Protection object to be deleted.
	//
	// ProtectionId is a required field
	ProtectionId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteProtectionInput) GoString 

func (s DeleteProtectionInput) GoString() string

GoString returns the string representation

func (*DeleteProtectionInput) SetProtectionId 

func (s *DeleteProtectionInput) SetProtectionId(v string) *DeleteProtectionInput

SetProtectionId sets the ProtectionId field's value.

func (DeleteProtectionInput) String 

func (s DeleteProtectionInput) String() string

String returns the string representation

func (*DeleteProtectionInput) Validate 

func (s *DeleteProtectionInput) Validate() error

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

type DeleteProtectionOutput 

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

func (DeleteProtectionOutput) GoString 

func (s DeleteProtectionOutput) GoString() string

GoString returns the string representation

func (DeleteProtectionOutput) String 

func (s DeleteProtectionOutput) String() string

String returns the string representation

type DeleteSubscriptionInput deprecated 

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

Deprecated: DeleteSubscriptionInput has been deprecated

func (DeleteSubscriptionInput) GoString 

func (s DeleteSubscriptionInput) GoString() string

GoString returns the string representation

func (DeleteSubscriptionInput) String 

func (s DeleteSubscriptionInput) String() string

String returns the string representation

type DeleteSubscriptionOutput deprecated 

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

Deprecated: DeleteSubscriptionOutput has been deprecated

func (DeleteSubscriptionOutput) GoString 

func (s DeleteSubscriptionOutput) GoString() string

GoString returns the string representation

func (DeleteSubscriptionOutput) String 

func (s DeleteSubscriptionOutput) String() string

String returns the string representation

type DescribeAttackInput 

type DescribeAttackInput struct {

	// The unique identifier (ID) for the attack that to be described.
	//
	// AttackId is a required field
	AttackId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeAttackInput) GoString 

func (s DescribeAttackInput) GoString() string

GoString returns the string representation

func (*DescribeAttackInput) SetAttackId 

func (s *DescribeAttackInput) SetAttackId(v string) *DescribeAttackInput

SetAttackId sets the AttackId field's value.

func (DescribeAttackInput) String 

func (s DescribeAttackInput) String() string

String returns the string representation

func (*DescribeAttackInput) Validate 

func (s *DescribeAttackInput) Validate() error

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

type DescribeAttackOutput 

type DescribeAttackOutput struct {

	// The attack that is described.
	Attack *AttackDetail `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeAttackOutput) GoString 

func (s DescribeAttackOutput) GoString() string

GoString returns the string representation

func (*DescribeAttackOutput) SetAttack 

func (s *DescribeAttackOutput) SetAttack(v *AttackDetail) *DescribeAttackOutput

SetAttack sets the Attack field's value.

func (DescribeAttackOutput) String 

func (s DescribeAttackOutput) String() string

String returns the string representation

type DescribeAttackStatisticsInput added in v1.35.28 

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

func (DescribeAttackStatisticsInput) GoString added in v1.35.28 

func (s DescribeAttackStatisticsInput) GoString() string

GoString returns the string representation

func (DescribeAttackStatisticsInput) String added in v1.35.28 

func (s DescribeAttackStatisticsInput) String() string

String returns the string representation

type DescribeAttackStatisticsOutput added in v1.35.28 

type DescribeAttackStatisticsOutput struct {

	// The data that describes the attacks detected during the time period.
	//
	// DataItems is a required field
	DataItems []*AttackStatisticsDataItem `type:"list" required:"true"`

	// The time range.
	//
	// TimeRange is a required field
	TimeRange *TimeRange `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeAttackStatisticsOutput) GoString added in v1.35.28 

func (s DescribeAttackStatisticsOutput) GoString() string

GoString returns the string representation

func (*DescribeAttackStatisticsOutput) SetDataItems added in v1.35.28 

func (s *DescribeAttackStatisticsOutput) SetDataItems(v []*AttackStatisticsDataItem) *DescribeAttackStatisticsOutput

SetDataItems sets the DataItems field's value.

func (*DescribeAttackStatisticsOutput) SetTimeRange added in v1.35.28 

func (s *DescribeAttackStatisticsOutput) SetTimeRange(v *TimeRange) *DescribeAttackStatisticsOutput

SetTimeRange sets the TimeRange field's value.

func (DescribeAttackStatisticsOutput) String added in v1.35.28 

func (s DescribeAttackStatisticsOutput) String() string

String returns the string representation

type DescribeDRTAccessInput added in v1.14.1 

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

func (DescribeDRTAccessInput) GoString added in v1.14.1 

func (s DescribeDRTAccessInput) GoString() string

GoString returns the string representation

func (DescribeDRTAccessInput) String added in v1.14.1 

func (s DescribeDRTAccessInput) String() string

String returns the string representation

type DescribeDRTAccessOutput added in v1.14.1 

type DescribeDRTAccessOutput struct {

	// The list of Amazon S3 buckets accessed by the DRT.
	LogBucketList []*string `type:"list"`

	// The Amazon Resource Name (ARN) of the role the DRT used to access your AWS
	// account.
	RoleArn *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeDRTAccessOutput) GoString added in v1.14.1 

func (s DescribeDRTAccessOutput) GoString() string

GoString returns the string representation

func (*DescribeDRTAccessOutput) SetLogBucketList added in v1.14.1 

func (s *DescribeDRTAccessOutput) SetLogBucketList(v []*string) *DescribeDRTAccessOutput

SetLogBucketList sets the LogBucketList field's value.

func (*DescribeDRTAccessOutput) SetRoleArn added in v1.14.1 

func (s *DescribeDRTAccessOutput) SetRoleArn(v string) *DescribeDRTAccessOutput

SetRoleArn sets the RoleArn field's value.

func (DescribeDRTAccessOutput) String added in v1.14.1 

func (s DescribeDRTAccessOutput) String() string

String returns the string representation

type DescribeEmergencyContactSettingsInput added in v1.14.1 

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

func (DescribeEmergencyContactSettingsInput) GoString added in v1.14.1 

func (s DescribeEmergencyContactSettingsInput) GoString() string

GoString returns the string representation

func (DescribeEmergencyContactSettingsInput) String added in v1.14.1 

func (s DescribeEmergencyContactSettingsInput) String() string

String returns the string representation

type DescribeEmergencyContactSettingsOutput added in v1.14.1 

type DescribeEmergencyContactSettingsOutput struct {

	// A list of email addresses and phone numbers that the DDoS Response Team (DRT)
	// can use to contact you if you have proactive engagement enabled, for escalations
	// to the DRT and to initiate proactive customer support.
	EmergencyContactList []*EmergencyContact `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeEmergencyContactSettingsOutput) GoString added in v1.14.1 

func (s DescribeEmergencyContactSettingsOutput) GoString() string

GoString returns the string representation

func (*DescribeEmergencyContactSettingsOutput) SetEmergencyContactList added in v1.14.1 

func (s *DescribeEmergencyContactSettingsOutput) SetEmergencyContactList(v []*EmergencyContact) *DescribeEmergencyContactSettingsOutput

SetEmergencyContactList sets the EmergencyContactList field's value.

func (DescribeEmergencyContactSettingsOutput) String added in v1.14.1 

func (s DescribeEmergencyContactSettingsOutput) String() string

String returns the string representation

type DescribeProtectionGroupInput added in v1.35.28 

type DescribeProtectionGroupInput struct {

	// The name of the protection group. You use this to identify the protection
	// group in lists and to manage the protection group, for example to update,
	// delete, or describe it.
	//
	// ProtectionGroupId is a required field
	ProtectionGroupId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeProtectionGroupInput) GoString added in v1.35.28 

func (s DescribeProtectionGroupInput) GoString() string

GoString returns the string representation

func (*DescribeProtectionGroupInput) SetProtectionGroupId added in v1.35.28 

func (s *DescribeProtectionGroupInput) SetProtectionGroupId(v string) *DescribeProtectionGroupInput

SetProtectionGroupId sets the ProtectionGroupId field's value.

func (DescribeProtectionGroupInput) String added in v1.35.28 

func (s DescribeProtectionGroupInput) String() string

String returns the string representation

func (*DescribeProtectionGroupInput) Validate added in v1.35.28 

func (s *DescribeProtectionGroupInput) Validate() error

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

type DescribeProtectionGroupOutput added in v1.35.28 

type DescribeProtectionGroupOutput struct {

	// A grouping of protected resources that you and AWS Shield Advanced can monitor
	// as a collective. This resource grouping improves the accuracy of detection
	// and reduces false positives.
	//
	// ProtectionGroup is a required field
	ProtectionGroup *ProtectionGroup `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeProtectionGroupOutput) GoString added in v1.35.28 

func (s DescribeProtectionGroupOutput) GoString() string

GoString returns the string representation

func (*DescribeProtectionGroupOutput) SetProtectionGroup added in v1.35.28 

func (s *DescribeProtectionGroupOutput) SetProtectionGroup(v *ProtectionGroup) *DescribeProtectionGroupOutput

SetProtectionGroup sets the ProtectionGroup field's value.

func (DescribeProtectionGroupOutput) String added in v1.35.28 

func (s DescribeProtectionGroupOutput) String() string

String returns the string representation

type DescribeProtectionInput 

type DescribeProtectionInput struct {

	// The unique identifier (ID) for the Protection object that is described. When
	// submitting the DescribeProtection request you must provide either the ResourceArn
	// or the ProtectionID, but not both.
	ProtectionId *string `min:"1" type:"string"`

	// The ARN (Amazon Resource Name) of the AWS resource for the Protection object
	// that is described. When submitting the DescribeProtection request you must
	// provide either the ResourceArn or the ProtectionID, but not both.
	ResourceArn *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeProtectionInput) GoString 

func (s DescribeProtectionInput) GoString() string

GoString returns the string representation

func (*DescribeProtectionInput) SetProtectionId 

func (s *DescribeProtectionInput) SetProtectionId(v string) *DescribeProtectionInput

SetProtectionId sets the ProtectionId field's value.

func (*DescribeProtectionInput) SetResourceArn added in v1.16.28 

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

SetResourceArn sets the ResourceArn field's value.

func (DescribeProtectionInput) String 

func (s DescribeProtectionInput) String() string

String returns the string representation

func (*DescribeProtectionInput) Validate 

func (s *DescribeProtectionInput) Validate() error

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

type DescribeProtectionOutput 

type DescribeProtectionOutput struct {

	// The Protection object that is described.
	Protection *Protection `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeProtectionOutput) GoString 

func (s DescribeProtectionOutput) GoString() string

GoString returns the string representation

func (*DescribeProtectionOutput) SetProtection 

func (s *DescribeProtectionOutput) SetProtection(v *Protection) *DescribeProtectionOutput

SetProtection sets the Protection field's value.

func (DescribeProtectionOutput) String 

func (s DescribeProtectionOutput) String() string

String returns the string representation

type DescribeSubscriptionInput 

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

func (DescribeSubscriptionInput) GoString 

func (s DescribeSubscriptionInput) GoString() string

GoString returns the string representation

func (DescribeSubscriptionInput) String 

func (s DescribeSubscriptionInput) String() string

String returns the string representation

type DescribeSubscriptionOutput 

type DescribeSubscriptionOutput struct {

	// The AWS Shield Advanced subscription details for an account.
	Subscription *Subscription `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeSubscriptionOutput) GoString 

func (s DescribeSubscriptionOutput) GoString() string

GoString returns the string representation

func (*DescribeSubscriptionOutput) SetSubscription 

func (s *DescribeSubscriptionOutput) SetSubscription(v *Subscription) *DescribeSubscriptionOutput

SetSubscription sets the Subscription field's value.

func (DescribeSubscriptionOutput) String 

func (s DescribeSubscriptionOutput) String() string

String returns the string representation

type DisableProactiveEngagementInput added in v1.31.13 

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

func (DisableProactiveEngagementInput) GoString added in v1.31.13 

func (s DisableProactiveEngagementInput) GoString() string

GoString returns the string representation

func (DisableProactiveEngagementInput) String added in v1.31.13 

func (s DisableProactiveEngagementInput) String() string

String returns the string representation

type DisableProactiveEngagementOutput added in v1.31.13 

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

func (DisableProactiveEngagementOutput) GoString added in v1.31.13 

func (s DisableProactiveEngagementOutput) GoString() string

GoString returns the string representation

func (DisableProactiveEngagementOutput) String added in v1.31.13 

func (s DisableProactiveEngagementOutput) String() string

String returns the string representation

type DisassociateDRTLogBucketInput added in v1.14.1 

type DisassociateDRTLogBucketInput struct {

	// The Amazon S3 bucket that contains your AWS WAF logs.
	//
	// LogBucket is a required field
	LogBucket *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DisassociateDRTLogBucketInput) GoString added in v1.14.1 

func (s DisassociateDRTLogBucketInput) GoString() string

GoString returns the string representation

func (*DisassociateDRTLogBucketInput) SetLogBucket added in v1.14.1 

func (s *DisassociateDRTLogBucketInput) SetLogBucket(v string) *DisassociateDRTLogBucketInput

SetLogBucket sets the LogBucket field's value.

func (DisassociateDRTLogBucketInput) String added in v1.14.1 

func (s DisassociateDRTLogBucketInput) String() string

String returns the string representation

func (*DisassociateDRTLogBucketInput) Validate added in v1.14.1 

func (s *DisassociateDRTLogBucketInput) Validate() error

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

type DisassociateDRTLogBucketOutput added in v1.14.1 

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

func (DisassociateDRTLogBucketOutput) GoString added in v1.14.1 

func (s DisassociateDRTLogBucketOutput) GoString() string

GoString returns the string representation

func (DisassociateDRTLogBucketOutput) String added in v1.14.1 

func (s DisassociateDRTLogBucketOutput) String() string

String returns the string representation

type DisassociateDRTRoleInput added in v1.14.1 

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

func (DisassociateDRTRoleInput) GoString added in v1.14.1 

func (s DisassociateDRTRoleInput) GoString() string

GoString returns the string representation

func (DisassociateDRTRoleInput) String added in v1.14.1 

func (s DisassociateDRTRoleInput) String() string

String returns the string representation

type DisassociateDRTRoleOutput added in v1.14.1 

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

func (DisassociateDRTRoleOutput) GoString added in v1.14.1 

func (s DisassociateDRTRoleOutput) GoString() string

GoString returns the string representation

func (DisassociateDRTRoleOutput) String added in v1.14.1 

func (s DisassociateDRTRoleOutput) String() string

String returns the string representation

type DisassociateHealthCheckInput added in v1.29.3 

type DisassociateHealthCheckInput struct {

	// The Amazon Resource Name (ARN) of the health check that is associated with
	// the protection.
	//
	// HealthCheckArn is a required field
	HealthCheckArn *string `min:"1" type:"string" required:"true"`

	// The unique identifier (ID) for the Protection object to remove the health
	// check association from.
	//
	// ProtectionId is a required field
	ProtectionId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DisassociateHealthCheckInput) GoString added in v1.29.3 

func (s DisassociateHealthCheckInput) GoString() string

GoString returns the string representation

func (*DisassociateHealthCheckInput) SetHealthCheckArn added in v1.29.3 

func (s *DisassociateHealthCheckInput) SetHealthCheckArn(v string) *DisassociateHealthCheckInput

SetHealthCheckArn sets the HealthCheckArn field's value.

func (*DisassociateHealthCheckInput) SetProtectionId added in v1.29.3 

func (s *DisassociateHealthCheckInput) SetProtectionId(v string) *DisassociateHealthCheckInput

SetProtectionId sets the ProtectionId field's value.

func (DisassociateHealthCheckInput) String added in v1.29.3 

func (s DisassociateHealthCheckInput) String() string

String returns the string representation

func (*DisassociateHealthCheckInput) Validate added in v1.29.3 

func (s *DisassociateHealthCheckInput) Validate() error

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

type DisassociateHealthCheckOutput added in v1.29.3 

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

func (DisassociateHealthCheckOutput) GoString added in v1.29.3 

func (s DisassociateHealthCheckOutput) GoString() string

GoString returns the string representation

func (DisassociateHealthCheckOutput) String added in v1.29.3 

func (s DisassociateHealthCheckOutput) String() string

String returns the string representation

type EmergencyContact added in v1.14.1 

type EmergencyContact struct {

	// Additional notes regarding the contact.
	ContactNotes *string `min:"1" type:"string"`

	// The email address for the contact.
	//
	// EmailAddress is a required field
	EmailAddress *string `min:"1" type:"string" required:"true"`

	// The phone number for the contact.
	PhoneNumber *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

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.

func (EmergencyContact) GoString added in v1.14.1 

func (s EmergencyContact) GoString() string

GoString returns the string representation

func (*EmergencyContact) SetContactNotes added in v1.31.13 

func (s *EmergencyContact) SetContactNotes(v string) *EmergencyContact

SetContactNotes sets the ContactNotes field's value.

func (*EmergencyContact) SetEmailAddress added in v1.14.1 

func (s *EmergencyContact) SetEmailAddress(v string) *EmergencyContact

SetEmailAddress sets the EmailAddress field's value.

func (*EmergencyContact) SetPhoneNumber added in v1.31.13 

func (s *EmergencyContact) SetPhoneNumber(v string) *EmergencyContact

SetPhoneNumber sets the PhoneNumber field's value.

func (EmergencyContact) String added in v1.14.1 

func (s EmergencyContact) String() string

String returns the string representation

func (*EmergencyContact) Validate added in v1.14.1 

func (s *EmergencyContact) Validate() error

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

type EnableProactiveEngagementInput added in v1.31.13 

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

func (EnableProactiveEngagementInput) GoString added in v1.31.13 

func (s EnableProactiveEngagementInput) GoString() string

GoString returns the string representation

func (EnableProactiveEngagementInput) String added in v1.31.13 

func (s EnableProactiveEngagementInput) String() string

String returns the string representation

type EnableProactiveEngagementOutput added in v1.31.13 

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

func (EnableProactiveEngagementOutput) GoString added in v1.31.13 

func (s EnableProactiveEngagementOutput) GoString() string

GoString returns the string representation

func (EnableProactiveEngagementOutput) String added in v1.31.13 

func (s EnableProactiveEngagementOutput) String() string

String returns the string representation

type GetSubscriptionStateInput added in v1.12.32 

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

func (GetSubscriptionStateInput) GoString added in v1.12.32 

func (s GetSubscriptionStateInput) GoString() string

GoString returns the string representation

func (GetSubscriptionStateInput) String added in v1.12.32 

func (s GetSubscriptionStateInput) String() string

String returns the string representation

type GetSubscriptionStateOutput added in v1.12.32 

type GetSubscriptionStateOutput struct {

	// The status of the subscription.
	//
	// SubscriptionState is a required field
	SubscriptionState *string `type:"string" required:"true" enum:"SubscriptionState"`
	// contains filtered or unexported fields
}

func (GetSubscriptionStateOutput) GoString added in v1.12.32 

func (s GetSubscriptionStateOutput) GoString() string

GoString returns the string representation

func (*GetSubscriptionStateOutput) SetSubscriptionState added in v1.12.32 

func (s *GetSubscriptionStateOutput) SetSubscriptionState(v string) *GetSubscriptionStateOutput

SetSubscriptionState sets the SubscriptionState field's value.

func (GetSubscriptionStateOutput) String added in v1.12.32 

func (s GetSubscriptionStateOutput) String() string

String returns the string representation

type InternalErrorException added in v1.28.0 

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

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

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

func (*InternalErrorException) Code added in v1.28.0 

func (s *InternalErrorException) Code() string

Code returns the exception type name.

func (*InternalErrorException) Error added in v1.28.0 

func (s *InternalErrorException) Error() string

func (InternalErrorException) GoString added in v1.28.0 

func (s InternalErrorException) GoString() string

GoString returns the string representation

func (*InternalErrorException) Message added in v1.28.0 

func (s *InternalErrorException) Message() string

Message returns the exception's message.

func (*InternalErrorException) OrigErr added in v1.28.0 

func (s *InternalErrorException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalErrorException) RequestID added in v1.28.0 

func (s *InternalErrorException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalErrorException) StatusCode added in v1.28.0 

func (s *InternalErrorException) StatusCode() int

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

func (InternalErrorException) String added in v1.28.0 

func (s InternalErrorException) String() string

String returns the string representation

type InvalidOperationException added in v1.28.0 

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

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

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

func (*InvalidOperationException) Code added in v1.28.0 

func (s *InvalidOperationException) Code() string

Code returns the exception type name.

func (*InvalidOperationException) Error added in v1.28.0 

func (s *InvalidOperationException) Error() string

func (InvalidOperationException) GoString added in v1.28.0 

func (s InvalidOperationException) GoString() string

GoString returns the string representation

func (*InvalidOperationException) Message added in v1.28.0 

func (s *InvalidOperationException) Message() string

Message returns the exception's message.

func (*InvalidOperationException) OrigErr added in v1.28.0 

func (s *InvalidOperationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidOperationException) RequestID added in v1.28.0 

func (s *InvalidOperationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidOperationException) StatusCode added in v1.28.0 

func (s *InvalidOperationException) StatusCode() int

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

func (InvalidOperationException) String added in v1.28.0 

func (s InvalidOperationException) String() string

String returns the string representation

type InvalidPaginationTokenException added in v1.28.0 

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

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

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) Code added in v1.28.0 

func (s *InvalidPaginationTokenException) Code() string

Code returns the exception type name.

func (*InvalidPaginationTokenException) Error added in v1.28.0 

func (s *InvalidPaginationTokenException) Error() string

func (InvalidPaginationTokenException) GoString added in v1.28.0 

func (s InvalidPaginationTokenException) GoString() string

GoString returns the string representation

func (*InvalidPaginationTokenException) Message added in v1.28.0 

func (s *InvalidPaginationTokenException) Message() string

Message returns the exception's message.

func (*InvalidPaginationTokenException) OrigErr added in v1.28.0 

func (s *InvalidPaginationTokenException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidPaginationTokenException) RequestID added in v1.28.0 

func (s *InvalidPaginationTokenException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidPaginationTokenException) StatusCode added in v1.28.0 

func (s *InvalidPaginationTokenException) StatusCode() int

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

func (InvalidPaginationTokenException) String added in v1.28.0 

func (s InvalidPaginationTokenException) String() string

String returns the string representation

type InvalidParameterException added in v1.28.0 

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

	// Fields that caused the exception.
	Fields []*ValidationExceptionField `locationName:"fields" type:"list"`

	Message_ *string `locationName:"message" type:"string"`

	// Additional information about the exception.
	Reason *string `locationName:"reason" type:"string" enum:"ValidationExceptionReason"`
	// contains filtered or unexported fields
}

Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

func (*InvalidParameterException) Code added in v1.28.0 

func (s *InvalidParameterException) Code() string

Code returns the exception type name.

func (*InvalidParameterException) Error added in v1.28.0 

func (s *InvalidParameterException) Error() string

func (InvalidParameterException) GoString added in v1.28.0 

func (s InvalidParameterException) GoString() string

GoString returns the string representation

func (*InvalidParameterException) Message added in v1.28.0 

func (s *InvalidParameterException) Message() string

Message returns the exception's message.

func (*InvalidParameterException) OrigErr added in v1.28.0 

func (s *InvalidParameterException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidParameterException) RequestID added in v1.28.0 

func (s *InvalidParameterException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidParameterException) StatusCode added in v1.28.0 

func (s *InvalidParameterException) StatusCode() int

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

func (InvalidParameterException) String added in v1.28.0 

func (s InvalidParameterException) String() string

String returns the string representation

type InvalidResourceException added in v1.28.0 

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

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

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

func (*InvalidResourceException) Code added in v1.28.0 

func (s *InvalidResourceException) Code() string

Code returns the exception type name.

func (*InvalidResourceException) Error added in v1.28.0 

func (s *InvalidResourceException) Error() string

func (InvalidResourceException) GoString added in v1.28.0 

func (s InvalidResourceException) GoString() string

GoString returns the string representation

func (*InvalidResourceException) Message added in v1.28.0 

func (s *InvalidResourceException) Message() string

Message returns the exception's message.

func (*InvalidResourceException) OrigErr added in v1.28.0 

func (s *InvalidResourceException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidResourceException) RequestID added in v1.28.0 

func (s *InvalidResourceException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidResourceException) StatusCode added in v1.28.0 

func (s *InvalidResourceException) StatusCode() int

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

func (InvalidResourceException) String added in v1.28.0 

func (s InvalidResourceException) String() string

String returns the string representation

type Limit added in v1.14.1 

type Limit struct {

	// The maximum number of protections that can be created for the specified Type.
	Max *int64 `type:"long"`

	// The type of protection.
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (Limit) GoString added in v1.14.1 

func (s Limit) GoString() string

GoString returns the string representation

func (*Limit) SetMax added in v1.14.1 

func (s *Limit) SetMax(v int64) *Limit

SetMax sets the Max field's value.

func (*Limit) SetType added in v1.14.1 

func (s *Limit) SetType(v string) *Limit

SetType sets the Type field's value.

func (Limit) String added in v1.14.1 

func (s Limit) String() string

String returns the string representation

type LimitsExceededException added in v1.28.0 

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

	// The threshold that would be exceeded.
	Limit *int64 `type:"long"`

	Message_ *string `locationName:"message" type:"string"`

	// The type of limit that would be exceeded.
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

Exception that indicates that the operation would exceed a limit.

func (*LimitsExceededException) Code added in v1.28.0 

func (s *LimitsExceededException) Code() string

Code returns the exception type name.

func (*LimitsExceededException) Error added in v1.28.0 

func (s *LimitsExceededException) Error() string

func (LimitsExceededException) GoString added in v1.28.0 

func (s LimitsExceededException) GoString() string

GoString returns the string representation

func (*LimitsExceededException) Message added in v1.28.0 

func (s *LimitsExceededException) Message() string

Message returns the exception's message.

func (*LimitsExceededException) OrigErr added in v1.28.0 

func (s *LimitsExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitsExceededException) RequestID added in v1.28.0 

func (s *LimitsExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitsExceededException) StatusCode added in v1.28.0 

func (s *LimitsExceededException) StatusCode() int

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

func (LimitsExceededException) String added in v1.28.0 

func (s LimitsExceededException) String() string

String returns the string representation

type ListAttacksInput 

type ListAttacksInput struct {

	// The end of the time period for the attacks. This is a timestamp type. The
	// sample request above indicates a number type because the default used by
	// WAF is Unix time in seconds. However any valid timestamp format (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types)
	// is allowed.
	EndTime *TimeRange `type:"structure"`

	// The maximum number of AttackSummary objects to return. If you leave this
	// blank, Shield Advanced returns the first 20 results.
	//
	// This is a maximum value. Shield Advanced might return the results in smaller
	// batches. That is, the number of objects returned could be less than MaxResults,
	// even if there are still more objects yet to return. If there are more objects
	// to return, Shield Advanced returns a value in NextToken that you can use
	// in your next request, to get the next batch of objects.
	MaxResults *int64 `type:"integer"`

	// The ListAttacksRequest.NextMarker value from a previous call to ListAttacksRequest.
	// Pass null if this is the first call.
	NextToken *string `min:"1" type:"string"`

	// The ARN (Amazon Resource Name) of the resource that was attacked. If this
	// is left blank, all applicable resources for this account will be included.
	ResourceArns []*string `type:"list"`

	// The start of the time period for the attacks. This is a timestamp type. The
	// sample request above indicates a number type because the default used by
	// WAF is Unix time in seconds. However any valid timestamp format (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types)
	// is allowed.
	StartTime *TimeRange `type:"structure"`
	// contains filtered or unexported fields
}

func (ListAttacksInput) GoString 

func (s ListAttacksInput) GoString() string

GoString returns the string representation

func (*ListAttacksInput) SetEndTime 

func (s *ListAttacksInput) SetEndTime(v *TimeRange) *ListAttacksInput

SetEndTime sets the EndTime field's value.

func (*ListAttacksInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListAttacksInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListAttacksInput) SetResourceArns 

func (s *ListAttacksInput) SetResourceArns(v []*string) *ListAttacksInput

SetResourceArns sets the ResourceArns field's value.

func (*ListAttacksInput) SetStartTime 

func (s *ListAttacksInput) SetStartTime(v *TimeRange) *ListAttacksInput

SetStartTime sets the StartTime field's value.

func (ListAttacksInput) String 

func (s ListAttacksInput) String() string

String returns the string representation

func (*ListAttacksInput) Validate 

func (s *ListAttacksInput) Validate() error

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

type ListAttacksOutput 

type ListAttacksOutput struct {

	// The attack information for the specified time range.
	AttackSummaries []*AttackSummary `type:"list"`

	// The token returned by a previous call to indicate that there is more data
	// available. If not null, more results are available. Pass this value for the
	// NextMarker parameter in a subsequent call to ListAttacks to retrieve the
	// next set of items.
	//
	// Shield Advanced might return the list of AttackSummary objects in batches
	// smaller than the number specified by MaxResults. If there are more attack
	// summary objects to return, Shield Advanced will always also return a NextToken.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAttacksOutput) GoString 

func (s ListAttacksOutput) GoString() string

GoString returns the string representation

func (*ListAttacksOutput) SetAttackSummaries 

func (s *ListAttacksOutput) SetAttackSummaries(v []*AttackSummary) *ListAttacksOutput

SetAttackSummaries sets the AttackSummaries field's value.

func (*ListAttacksOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListAttacksOutput) String 

func (s ListAttacksOutput) String() string

String returns the string representation

type ListProtectionGroupsInput added in v1.35.28 

type ListProtectionGroupsInput struct {

	// The maximum number of ProtectionGroup objects to return. If you leave this
	// blank, Shield Advanced returns the first 20 results.
	//
	// This is a maximum value. Shield Advanced might return the results in smaller
	// batches. That is, the number of objects returned could be less than MaxResults,
	// even if there are still more objects yet to return. If there are more objects
	// to return, Shield Advanced returns a value in NextToken that you can use
	// in your next request, to get the next batch of objects.
	MaxResults *int64 `type:"integer"`

	// The next token value from a previous call to ListProtectionGroups. Pass null
	// if this is the first call.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListProtectionGroupsInput) GoString added in v1.35.28 

func (s ListProtectionGroupsInput) GoString() string

GoString returns the string representation

func (*ListProtectionGroupsInput) SetMaxResults added in v1.35.28 

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

SetMaxResults sets the MaxResults field's value.

func (*ListProtectionGroupsInput) SetNextToken added in v1.35.28 

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

SetNextToken sets the NextToken field's value.

func (ListProtectionGroupsInput) String added in v1.35.28 

func (s ListProtectionGroupsInput) String() string

String returns the string representation

func (*ListProtectionGroupsInput) Validate added in v1.35.28 

func (s *ListProtectionGroupsInput) Validate() error

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

type ListProtectionGroupsOutput added in v1.35.28 

type ListProtectionGroupsOutput struct {

	// If you specify a value for MaxResults and you have more protection groups
	// than the value of MaxResults, AWS Shield Advanced returns this token that
	// you can use in your next request, to get the next batch of objects.
	NextToken *string `min:"1" type:"string"`

	// ProtectionGroups is a required field
	ProtectionGroups []*ProtectionGroup `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (ListProtectionGroupsOutput) GoString added in v1.35.28 

func (s ListProtectionGroupsOutput) GoString() string

GoString returns the string representation

func (*ListProtectionGroupsOutput) SetNextToken added in v1.35.28 

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

SetNextToken sets the NextToken field's value.

func (*ListProtectionGroupsOutput) SetProtectionGroups added in v1.35.28 

func (s *ListProtectionGroupsOutput) SetProtectionGroups(v []*ProtectionGroup) *ListProtectionGroupsOutput

SetProtectionGroups sets the ProtectionGroups field's value.

func (ListProtectionGroupsOutput) String added in v1.35.28 

func (s ListProtectionGroupsOutput) String() string

String returns the string representation

type ListProtectionsInput 

type ListProtectionsInput struct {

	// The maximum number of Protection objects to return. If you leave this blank,
	// Shield Advanced returns the first 20 results.
	//
	// This is a maximum value. Shield Advanced might return the results in smaller
	// batches. That is, the number of objects returned could be less than MaxResults,
	// even if there are still more objects yet to return. If there are more objects
	// to return, Shield Advanced returns a value in NextToken that you can use
	// in your next request, to get the next batch of objects.
	MaxResults *int64 `type:"integer"`

	// The ListProtectionsRequest.NextToken value from a previous call to ListProtections.
	// Pass null if this is the first call.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListProtectionsInput) GoString 

func (s ListProtectionsInput) GoString() string

GoString returns the string representation

func (*ListProtectionsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListProtectionsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListProtectionsInput) String 

func (s ListProtectionsInput) String() string

String returns the string representation

func (*ListProtectionsInput) Validate 

func (s *ListProtectionsInput) Validate() error

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

type ListProtectionsOutput 

type ListProtectionsOutput struct {

	// If you specify a value for MaxResults and you have more Protections than
	// the value of MaxResults, AWS Shield Advanced returns a NextToken value in
	// the response that allows you to list another group of Protections. For the
	// second and subsequent ListProtections requests, specify the value of NextToken
	// from the previous response to get information about another batch of Protections.
	//
	// Shield Advanced might return the list of Protection objects in batches smaller
	// than the number specified by MaxResults. If there are more Protection objects
	// to return, Shield Advanced will always also return a NextToken.
	NextToken *string `min:"1" type:"string"`

	// The array of enabled Protection objects.
	Protections []*Protection `type:"list"`
	// contains filtered or unexported fields
}

func (ListProtectionsOutput) GoString 

func (s ListProtectionsOutput) GoString() string

GoString returns the string representation

func (*ListProtectionsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListProtectionsOutput) SetProtections 

func (s *ListProtectionsOutput) SetProtections(v []*Protection) *ListProtectionsOutput

SetProtections sets the Protections field's value.

func (ListProtectionsOutput) String 

func (s ListProtectionsOutput) String() string

String returns the string representation

type ListResourcesInProtectionGroupInput added in v1.35.28 

type ListResourcesInProtectionGroupInput struct {

	// The maximum number of resource ARN objects to return. If you leave this blank,
	// Shield Advanced returns the first 20 results.
	//
	// This is a maximum value. Shield Advanced might return the results in smaller
	// batches. That is, the number of objects returned could be less than MaxResults,
	// even if there are still more objects yet to return. If there are more objects
	// to return, Shield Advanced returns a value in NextToken that you can use
	// in your next request, to get the next batch of objects.
	MaxResults *int64 `type:"integer"`

	// The next token value from a previous call to ListResourcesInProtectionGroup.
	// Pass null if this is the first call.
	NextToken *string `min:"1" type:"string"`

	// The name of the protection group. You use this to identify the protection
	// group in lists and to manage the protection group, for example to update,
	// delete, or describe it.
	//
	// ProtectionGroupId is a required field
	ProtectionGroupId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListResourcesInProtectionGroupInput) GoString added in v1.35.28 

func (s ListResourcesInProtectionGroupInput) GoString() string

GoString returns the string representation

func (*ListResourcesInProtectionGroupInput) SetMaxResults added in v1.35.28 

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

SetMaxResults sets the MaxResults field's value.

func (*ListResourcesInProtectionGroupInput) SetNextToken added in v1.35.28 

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

SetNextToken sets the NextToken field's value.

func (*ListResourcesInProtectionGroupInput) SetProtectionGroupId added in v1.35.28 

func (s *ListResourcesInProtectionGroupInput) SetProtectionGroupId(v string) *ListResourcesInProtectionGroupInput

SetProtectionGroupId sets the ProtectionGroupId field's value.

func (ListResourcesInProtectionGroupInput) String added in v1.35.28 

func (s ListResourcesInProtectionGroupInput) String() string

String returns the string representation

func (*ListResourcesInProtectionGroupInput) Validate added in v1.35.28 

func (s *ListResourcesInProtectionGroupInput) Validate() error

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

type ListResourcesInProtectionGroupOutput added in v1.35.28 

type ListResourcesInProtectionGroupOutput struct {

	// If you specify a value for MaxResults and you have more resources in the
	// protection group than the value of MaxResults, AWS Shield Advanced returns
	// this token that you can use in your next request, to get the next batch of
	// objects.
	NextToken *string `min:"1" type:"string"`

	// The Amazon Resource Names (ARNs) of the resources that are included in the
	// protection group.
	//
	// ResourceArns is a required field
	ResourceArns []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (ListResourcesInProtectionGroupOutput) GoString added in v1.35.28 

func (s ListResourcesInProtectionGroupOutput) GoString() string

GoString returns the string representation

func (*ListResourcesInProtectionGroupOutput) SetNextToken added in v1.35.28 

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

SetNextToken sets the NextToken field's value.

func (*ListResourcesInProtectionGroupOutput) SetResourceArns added in v1.35.28 

func (s *ListResourcesInProtectionGroupOutput) SetResourceArns(v []*string) *ListResourcesInProtectionGroupOutput

SetResourceArns sets the ResourceArns field's value.

func (ListResourcesInProtectionGroupOutput) String added in v1.35.28 

func (s ListResourcesInProtectionGroupOutput) String() string

String returns the string representation

type ListTagsForResourceInput added in v1.37.25 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource to get tags for.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString added in v1.37.25 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceInput) SetResourceARN added in v1.37.25 

func (s *ListTagsForResourceInput) SetResourceARN(v string) *ListTagsForResourceInput

SetResourceARN sets the ResourceARN field's value.

func (ListTagsForResourceInput) String added in v1.37.25 

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate added in v1.37.25 

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput added in v1.37.25 

type ListTagsForResourceOutput struct {

	// A list of tag key and value pairs associated with the specified resource.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString added in v1.37.25 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceOutput) SetTags added in v1.37.25 

func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v1.37.25 

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type LockedSubscriptionException added in v1.28.0 

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

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

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) Code added in v1.28.0 

func (s *LockedSubscriptionException) Code() string

Code returns the exception type name.

func (*LockedSubscriptionException) Error added in v1.28.0 

func (s *LockedSubscriptionException) Error() string

func (LockedSubscriptionException) GoString added in v1.28.0 

func (s LockedSubscriptionException) GoString() string

GoString returns the string representation

func (*LockedSubscriptionException) Message added in v1.28.0 

func (s *LockedSubscriptionException) Message() string

Message returns the exception's message.

func (*LockedSubscriptionException) OrigErr added in v1.28.0 

func (s *LockedSubscriptionException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LockedSubscriptionException) RequestID added in v1.28.0 

func (s *LockedSubscriptionException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LockedSubscriptionException) StatusCode added in v1.28.0 

func (s *LockedSubscriptionException) StatusCode() int

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

func (LockedSubscriptionException) String added in v1.28.0 

func (s LockedSubscriptionException) String() string

String returns the string representation

type Mitigation 

type Mitigation struct {

	// The name of the mitigation taken for this attack.
	MitigationName *string `type:"string"`
	// contains filtered or unexported fields
}

The mitigation applied to a DDoS attack.

func (Mitigation) GoString 

func (s Mitigation) GoString() string

GoString returns the string representation

func (*Mitigation) SetMitigationName 

func (s *Mitigation) SetMitigationName(v string) *Mitigation

SetMitigationName sets the MitigationName field's value.

func (Mitigation) String 

func (s Mitigation) String() string

String returns the string representation

type NoAssociatedRoleException added in v1.28.0 

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

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

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

func (*NoAssociatedRoleException) Code added in v1.28.0 

func (s *NoAssociatedRoleException) Code() string

Code returns the exception type name.

func (*NoAssociatedRoleException) Error added in v1.28.0 

func (s *NoAssociatedRoleException) Error() string

func (NoAssociatedRoleException) GoString added in v1.28.0 

func (s NoAssociatedRoleException) GoString() string

GoString returns the string representation

func (*NoAssociatedRoleException) Message added in v1.28.0 

func (s *NoAssociatedRoleException) Message() string

Message returns the exception's message.

func (*NoAssociatedRoleException) OrigErr added in v1.28.0 

func (s *NoAssociatedRoleException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NoAssociatedRoleException) RequestID added in v1.28.0 

func (s *NoAssociatedRoleException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NoAssociatedRoleException) StatusCode added in v1.28.0 

func (s *NoAssociatedRoleException) StatusCode() int

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

func (NoAssociatedRoleException) String added in v1.28.0 

func (s NoAssociatedRoleException) String() string

String returns the string representation

type OptimisticLockException added in v1.28.0 

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

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

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

func (*OptimisticLockException) Code added in v1.28.0 

func (s *OptimisticLockException) Code() string

Code returns the exception type name.

func (*OptimisticLockException) Error added in v1.28.0 

func (s *OptimisticLockException) Error() string

func (OptimisticLockException) GoString added in v1.28.0 

func (s OptimisticLockException) GoString() string

GoString returns the string representation

func (*OptimisticLockException) Message added in v1.28.0 

func (s *OptimisticLockException) Message() string

Message returns the exception's message.

func (*OptimisticLockException) OrigErr added in v1.28.0 

func (s *OptimisticLockException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*OptimisticLockException) RequestID added in v1.28.0 

func (s *OptimisticLockException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*OptimisticLockException) StatusCode added in v1.28.0 

func (s *OptimisticLockException) StatusCode() int

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

func (OptimisticLockException) String added in v1.28.0 

func (s OptimisticLockException) String() string

String returns the string representation

type Protection 

type Protection struct {

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

	// The unique identifier (ID) of the protection.
	Id *string `min:"1" type:"string"`

	// The name of the protection. For example, My CloudFront distributions.
	Name *string `min:"1" type:"string"`

	// The ARN (Amazon Resource Name) of the protection.
	ProtectionArn *string `min:"1" type:"string"`

	// The ARN (Amazon Resource Name) of the AWS resource that is protected.
	ResourceArn *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (Protection) GoString 

func (s Protection) GoString() string

GoString returns the string representation

func (*Protection) SetHealthCheckIds added in v1.29.3 

func (s *Protection) SetHealthCheckIds(v []*string) *Protection

SetHealthCheckIds sets the HealthCheckIds field's value.

func (*Protection) SetId 

func (s *Protection) SetId(v string) *Protection

SetId sets the Id field's value.

func (*Protection) SetName 

func (s *Protection) SetName(v string) *Protection

SetName sets the Name field's value.

func (*Protection) SetProtectionArn added in v1.37.25 

func (s *Protection) SetProtectionArn(v string) *Protection

SetProtectionArn sets the ProtectionArn field's value.

func (*Protection) SetResourceArn 

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

SetResourceArn sets the ResourceArn field's value.

func (Protection) String 

func (s Protection) String() string

String returns the string representation

type ProtectionGroup added in v1.35.28 

type ProtectionGroup struct {

	// Defines how AWS Shield combines resource data for the group in order to detect,
	// mitigate, and report events.
	//
	//    * Sum - Use the total traffic across the group. This is a good choice
	//    for most cases. Examples include Elastic IP addresses for EC2 instances
	//    that scale manually or automatically.
	//
	//    * Mean - Use the average of the traffic across the group. This is a good
	//    choice for resources that share traffic uniformly. Examples include accelerators
	//    and load balancers.
	//
	//    * Max - Use the highest traffic from each resource. This is useful for
	//    resources that don't share traffic and for resources that share that traffic
	//    in a non-uniform way. Examples include CloudFront distributions and origin
	//    resources for CloudFront distributions.
	//
	// Aggregation is a required field
	Aggregation *string `type:"string" required:"true" enum:"ProtectionGroupAggregation"`

	// The Amazon Resource Names (ARNs) of the resources to include in the protection
	// group. You must set this when you set Pattern to ARBITRARY and you must not
	// set it for any other Pattern setting.
	//
	// Members is a required field
	Members []*string `type:"list" required:"true"`

	// The criteria to use to choose the protected resources for inclusion in the
	// group. You can include all resources that have protections, provide a list
	// of resource Amazon Resource Names (ARNs), or include all resources of a specified
	// resource type.
	//
	// Pattern is a required field
	Pattern *string `type:"string" required:"true" enum:"ProtectionGroupPattern"`

	// The ARN (Amazon Resource Name) of the protection group.
	ProtectionGroupArn *string `min:"1" type:"string"`

	// The name of the protection group. You use this to identify the protection
	// group in lists and to manage the protection group, for example to update,
	// delete, or describe it.
	//
	// ProtectionGroupId is a required field
	ProtectionGroupId *string `min:"1" type:"string" required:"true"`

	// The resource type to include in the protection group. All protected resources
	// of this type are included in the protection group. You must set this when
	// you set Pattern to BY_RESOURCE_TYPE and you must not set it for any other
	// Pattern setting.
	ResourceType *string `type:"string" enum:"ProtectedResourceType"`
	// contains filtered or unexported fields
}

A grouping of protected resources that you and AWS Shield Advanced can monitor as a collective. This resource grouping improves the accuracy of detection and reduces false positives.

func (ProtectionGroup) GoString added in v1.35.28 

func (s ProtectionGroup) GoString() string

GoString returns the string representation

func (*ProtectionGroup) SetAggregation added in v1.35.28 

func (s *ProtectionGroup) SetAggregation(v string) *ProtectionGroup

SetAggregation sets the Aggregation field's value.

func (*ProtectionGroup) SetMembers added in v1.35.28 

func (s *ProtectionGroup) SetMembers(v []*string) *ProtectionGroup

SetMembers sets the Members field's value.

func (*ProtectionGroup) SetPattern added in v1.35.28 

func (s *ProtectionGroup) SetPattern(v string) *ProtectionGroup

SetPattern sets the Pattern field's value.

func (*ProtectionGroup) SetProtectionGroupArn added in v1.37.25 

func (s *ProtectionGroup) SetProtectionGroupArn(v string) *ProtectionGroup

SetProtectionGroupArn sets the ProtectionGroupArn field's value.

func (*ProtectionGroup) SetProtectionGroupId added in v1.35.28 

func (s *ProtectionGroup) SetProtectionGroupId(v string) *ProtectionGroup

SetProtectionGroupId sets the ProtectionGroupId field's value.

func (*ProtectionGroup) SetResourceType added in v1.35.28 

func (s *ProtectionGroup) SetResourceType(v string) *ProtectionGroup

SetResourceType sets the ResourceType field's value.

func (ProtectionGroup) String added in v1.35.28 

func (s ProtectionGroup) String() string

String returns the string representation

type ProtectionGroupArbitraryPatternLimits added in v1.35.28 

type ProtectionGroupArbitraryPatternLimits struct {

	// The maximum number of resources you can specify for a single arbitrary pattern
	// in a protection group.
	//
	// MaxMembers is a required field
	MaxMembers *int64 `type:"long" required:"true"`
	// contains filtered or unexported fields
}

Limits settings on protection groups with arbitrary pattern type.

func (ProtectionGroupArbitraryPatternLimits) GoString added in v1.35.28 

func (s ProtectionGroupArbitraryPatternLimits) GoString() string

GoString returns the string representation

func (*ProtectionGroupArbitraryPatternLimits) SetMaxMembers added in v1.35.28 

func (s *ProtectionGroupArbitraryPatternLimits) SetMaxMembers(v int64) *ProtectionGroupArbitraryPatternLimits

SetMaxMembers sets the MaxMembers field's value.

func (ProtectionGroupArbitraryPatternLimits) String added in v1.35.28 

func (s ProtectionGroupArbitraryPatternLimits) String() string

String returns the string representation

type ProtectionGroupLimits added in v1.35.28 

type ProtectionGroupLimits struct {

	// The maximum number of protection groups that you can have at one time.
	//
	// MaxProtectionGroups is a required field
	MaxProtectionGroups *int64 `type:"long" required:"true"`

	// Limits settings by pattern type in the protection groups for your subscription.
	//
	// PatternTypeLimits is a required field
	PatternTypeLimits *ProtectionGroupPatternTypeLimits `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Limits settings on protection groups for your subscription.

func (ProtectionGroupLimits) GoString added in v1.35.28 

func (s ProtectionGroupLimits) GoString() string

GoString returns the string representation

func (*ProtectionGroupLimits) SetMaxProtectionGroups added in v1.35.28 

func (s *ProtectionGroupLimits) SetMaxProtectionGroups(v int64) *ProtectionGroupLimits

SetMaxProtectionGroups sets the MaxProtectionGroups field's value.

func (*ProtectionGroupLimits) SetPatternTypeLimits added in v1.35.28 

func (s *ProtectionGroupLimits) SetPatternTypeLimits(v *ProtectionGroupPatternTypeLimits) *ProtectionGroupLimits

SetPatternTypeLimits sets the PatternTypeLimits field's value.

func (ProtectionGroupLimits) String added in v1.35.28 

func (s ProtectionGroupLimits) String() string

String returns the string representation

type ProtectionGroupPatternTypeLimits added in v1.35.28 

type ProtectionGroupPatternTypeLimits struct {

	// Limits settings on protection groups with arbitrary pattern type.
	//
	// ArbitraryPatternLimits is a required field
	ArbitraryPatternLimits *ProtectionGroupArbitraryPatternLimits `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Limits settings by pattern type in the protection groups for your subscription.

func (ProtectionGroupPatternTypeLimits) GoString added in v1.35.28 

func (s ProtectionGroupPatternTypeLimits) GoString() string

GoString returns the string representation

func (*ProtectionGroupPatternTypeLimits) SetArbitraryPatternLimits added in v1.35.28 

func (s *ProtectionGroupPatternTypeLimits) SetArbitraryPatternLimits(v *ProtectionGroupArbitraryPatternLimits) *ProtectionGroupPatternTypeLimits

SetArbitraryPatternLimits sets the ArbitraryPatternLimits field's value.

func (ProtectionGroupPatternTypeLimits) String added in v1.35.28 

func (s ProtectionGroupPatternTypeLimits) String() string

String returns the string representation

type ProtectionLimits added in v1.35.28 

type ProtectionLimits struct {

	// The maximum number of resource types that you can specify in a protection.
	//
	// ProtectedResourceTypeLimits is a required field
	ProtectedResourceTypeLimits []*Limit `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Limits settings on protections for your subscription.

func (ProtectionLimits) GoString added in v1.35.28 

func (s ProtectionLimits) GoString() string

GoString returns the string representation

func (*ProtectionLimits) SetProtectedResourceTypeLimits added in v1.35.28 

func (s *ProtectionLimits) SetProtectedResourceTypeLimits(v []*Limit) *ProtectionLimits

SetProtectedResourceTypeLimits sets the ProtectedResourceTypeLimits field's value.

func (ProtectionLimits) String added in v1.35.28 

func (s ProtectionLimits) String() string

String returns the string representation

type ResourceAlreadyExistsException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"string"`

	// The type of resource that already exists.
	ResourceType *string `locationName:"resourceType" type:"string"`
	// contains filtered or unexported fields
}

Exception indicating the specified resource already exists. If available, this exception includes details in additional properties.

func (*ResourceAlreadyExistsException) Code added in v1.28.0 

func (s *ResourceAlreadyExistsException) Code() string

Code returns the exception type name.

func (*ResourceAlreadyExistsException) Error added in v1.28.0 

func (s *ResourceAlreadyExistsException) Error() string

func (ResourceAlreadyExistsException) GoString added in v1.28.0 

func (s ResourceAlreadyExistsException) GoString() string

GoString returns the string representation

func (*ResourceAlreadyExistsException) Message added in v1.28.0 

func (s *ResourceAlreadyExistsException) Message() string

Message returns the exception's message.

func (*ResourceAlreadyExistsException) OrigErr added in v1.28.0 

func (s *ResourceAlreadyExistsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceAlreadyExistsException) RequestID added in v1.28.0 

func (s *ResourceAlreadyExistsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceAlreadyExistsException) StatusCode added in v1.28.0 

func (s *ResourceAlreadyExistsException) StatusCode() int

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

func (ResourceAlreadyExistsException) String added in v1.28.0 

func (s ResourceAlreadyExistsException) String() string

String returns the string representation

type ResourceNotFoundException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"string"`

	// Type of resource.
	ResourceType *string `locationName:"resourceType" type:"string"`
	// contains filtered or unexported fields
}

Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

func (*ResourceNotFoundException) Code added in v1.28.0 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error added in v1.28.0 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString added in v1.28.0 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation

func (*ResourceNotFoundException) Message added in v1.28.0 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr added in v1.28.0 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID added in v1.28.0 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode added in v1.28.0 

func (s *ResourceNotFoundException) StatusCode() int

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

func (ResourceNotFoundException) String added in v1.28.0 

func (s ResourceNotFoundException) String() string

String returns the string representation

type Shield 

type Shield struct {
	*client.Client
}

Shield provides the API operation methods for making requests to AWS Shield. See this package's package overview docs for details on the service.

Shield 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) *Shield

New creates a new instance of the Shield 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 Shield client from just a session.
svc := shield.New(mySession)

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

func (*Shield) AssociateDRTLogBucket added in v1.14.1 

func (c *Shield) AssociateDRTLogBucket(input *AssociateDRTLogBucketInput) (*AssociateDRTLogBucketOutput, error)

AssociateDRTLogBucket API operation for AWS Shield.

Authorizes the DDoS Response Team (DRT) to access the specified Amazon S3 bucket containing your AWS WAF logs. You can associate up to 10 Amazon S3 buckets with your subscription.

To use the services of the DRT and make an AssociateDRTLogBucket request, you must be subscribed to the Business Support plan (https://aws.amazon.com/premiumsupport/business-support/) or the Enterprise Support plan (https://aws.amazon.com/premiumsupport/enterprise-support/).

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 AWS Shield's API operation AssociateDRTLogBucket for usage and error information.

Returned Error Types:

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

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

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

  • LimitsExceededException Exception that indicates that the operation would exceed a limit.

  • InvalidParameterException Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

  • AccessDeniedForDependencyException 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).

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

  • ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/AssociateDRTLogBucket

func (*Shield) AssociateDRTLogBucketRequest added in v1.14.1 

func (c *Shield) AssociateDRTLogBucketRequest(input *AssociateDRTLogBucketInput) (req *request.Request, output *AssociateDRTLogBucketOutput)

AssociateDRTLogBucketRequest generates a "aws/request.Request" representing the client's request for the AssociateDRTLogBucket 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 AssociateDRTLogBucket for more information on using the AssociateDRTLogBucket 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 AssociateDRTLogBucketRequest method.
req, resp := client.AssociateDRTLogBucketRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/AssociateDRTLogBucket

func (*Shield) AssociateDRTLogBucketWithContext added in v1.14.1 

func (c *Shield) AssociateDRTLogBucketWithContext(ctx aws.Context, input *AssociateDRTLogBucketInput, opts ...request.Option) (*AssociateDRTLogBucketOutput, error)

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

See AssociateDRTLogBucket 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 (*Shield) AssociateDRTRole added in v1.14.1 

func (c *Shield) AssociateDRTRole(input *AssociateDRTRoleInput) (*AssociateDRTRoleOutput, error)

AssociateDRTRole API operation for AWS Shield.

Authorizes the DDoS Response Team (DRT), using the specified role, to access your AWS account to assist with DDoS attack mitigation during potential attacks. This enables the DRT to inspect your AWS WAF configuration and create or update AWS WAF rules and web ACLs.

You can associate only one RoleArn with your subscription. If you submit an AssociateDRTRole request for an account that already has an associated role, the new RoleArn will replace the existing RoleArn.

Prior to making the AssociateDRTRole request, you must attach the AWSShieldDRTAccessPolicy (https://console.aws.amazon.com/iam/home?#/policies/arn:aws:iam::aws:policy/service-role/AWSShieldDRTAccessPolicy) managed policy to the role you will specify in the request. For more information see Attaching and Detaching IAM Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_manage-attach-detach.html). The role must also trust the service principal drt.shield.amazonaws.com. For more information, see IAM JSON Policy Elements: Principal (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html).

The DRT will have access only to your AWS WAF and Shield resources. By submitting this request, you authorize the DRT to inspect your AWS WAF and Shield configuration and create and update AWS WAF rules and web ACLs on your behalf. The DRT takes these actions only if explicitly authorized by you.

You must have the iam:PassRole permission to make an AssociateDRTRole request. 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).

To use the services of the DRT and make an AssociateDRTRole request, you must be subscribed to the Business Support plan (https://aws.amazon.com/premiumsupport/business-support/) or the Enterprise Support plan (https://aws.amazon.com/premiumsupport/enterprise-support/).

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 AWS Shield's API operation AssociateDRTRole for usage and error information.

Returned Error Types:

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

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

  • InvalidParameterException Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

  • AccessDeniedForDependencyException 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).

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

  • ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/AssociateDRTRole

func (*Shield) AssociateDRTRoleRequest added in v1.14.1 

func (c *Shield) AssociateDRTRoleRequest(input *AssociateDRTRoleInput) (req *request.Request, output *AssociateDRTRoleOutput)

AssociateDRTRoleRequest generates a "aws/request.Request" representing the client's request for the AssociateDRTRole 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 AssociateDRTRole for more information on using the AssociateDRTRole 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 AssociateDRTRoleRequest method.
req, resp := client.AssociateDRTRoleRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/AssociateDRTRole

func (*Shield) AssociateDRTRoleWithContext added in v1.14.1 

func (c *Shield) AssociateDRTRoleWithContext(ctx aws.Context, input *AssociateDRTRoleInput, opts ...request.Option) (*AssociateDRTRoleOutput, error)

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

See AssociateDRTRole 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 (*Shield) AssociateHealthCheck added in v1.29.3 

func (c *Shield) AssociateHealthCheck(input *AssociateHealthCheckInput) (*AssociateHealthCheckOutput, error)

AssociateHealthCheck API operation for AWS Shield.

Adds health-based detection to the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your AWS resource to improve responsiveness and accuracy in attack detection and mitigation.

You define the health check in Route 53 and then associate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection (https://docs.aws.amazon.com/waf/latest/developerguide/ddos-overview.html#ddos-advanced-health-check-option) in the AWS WAF and AWS Shield Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/).

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 AWS Shield's API operation AssociateHealthCheck for usage and error information.

Returned Error Types:

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

  • LimitsExceededException Exception that indicates that the operation would exceed a limit.

  • ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

  • InvalidParameterException Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/AssociateHealthCheck

func (*Shield) AssociateHealthCheckRequest added in v1.29.3 

func (c *Shield) AssociateHealthCheckRequest(input *AssociateHealthCheckInput) (req *request.Request, output *AssociateHealthCheckOutput)

AssociateHealthCheckRequest generates a "aws/request.Request" representing the client's request for the AssociateHealthCheck 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 AssociateHealthCheck for more information on using the AssociateHealthCheck 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 AssociateHealthCheckRequest method.
req, resp := client.AssociateHealthCheckRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/AssociateHealthCheck

func (*Shield) AssociateHealthCheckWithContext added in v1.29.3 

func (c *Shield) AssociateHealthCheckWithContext(ctx aws.Context, input *AssociateHealthCheckInput, opts ...request.Option) (*AssociateHealthCheckOutput, error)

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

See AssociateHealthCheck 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 (*Shield) AssociateProactiveEngagementDetails added in v1.31.13 

func (c *Shield) AssociateProactiveEngagementDetails(input *AssociateProactiveEngagementDetailsInput) (*AssociateProactiveEngagementDetailsOutput, error)

AssociateProactiveEngagementDetails API operation for AWS Shield.

Initializes proactive engagement and sets the list of contacts for the DDoS Response Team (DRT) to use. You must provide at least one phone number in the emergency contact list.

After you have initialized proactive engagement using this call, to disable or enable proactive engagement, use the calls DisableProactiveEngagement and EnableProactiveEngagement.

This call defines the list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you for escalations to the DRT and to initiate proactive customer support.

The contacts that you provide in the request replace any contacts that were already defined. If you already have contacts defined and want to use them, retrieve the list using DescribeEmergencyContactSettings and then provide it to this call.

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 AWS Shield's API operation AssociateProactiveEngagementDetails for usage and error information.

Returned Error Types:

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

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

  • InvalidParameterException Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

  • ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/AssociateProactiveEngagementDetails

func (*Shield) AssociateProactiveEngagementDetailsRequest added in v1.31.13 

func (c *Shield) AssociateProactiveEngagementDetailsRequest(input *AssociateProactiveEngagementDetailsInput) (req *request.Request, output *AssociateProactiveEngagementDetailsOutput)

AssociateProactiveEngagementDetailsRequest generates a "aws/request.Request" representing the client's request for the AssociateProactiveEngagementDetails 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 AssociateProactiveEngagementDetails for more information on using the AssociateProactiveEngagementDetails 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 AssociateProactiveEngagementDetailsRequest method.
req, resp := client.AssociateProactiveEngagementDetailsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/AssociateProactiveEngagementDetails

func (*Shield) AssociateProactiveEngagementDetailsWithContext added in v1.31.13 

func (c *Shield) AssociateProactiveEngagementDetailsWithContext(ctx aws.Context, input *AssociateProactiveEngagementDetailsInput, opts ...request.Option) (*AssociateProactiveEngagementDetailsOutput, error)

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

See AssociateProactiveEngagementDetails 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 (*Shield) CreateProtection 

func (c *Shield) CreateProtection(input *CreateProtectionInput) (*CreateProtectionOutput, error)

CreateProtection API operation for AWS Shield.

Enables AWS Shield Advanced for a specific AWS resource. The resource can be an Amazon CloudFront distribution, Elastic Load Balancing load balancer, AWS Global Accelerator accelerator, Elastic IP Address, or an Amazon Route 53 hosted zone.

You can add protection to only a single resource with each CreateProtection request. If you want to add protection to multiple resources at once, use the AWS WAF console (https://console.aws.amazon.com/waf/). For more information see Getting Started with AWS Shield Advanced (https://docs.aws.amazon.com/waf/latest/developerguide/getting-started-ddos.html) and Add AWS Shield Advanced Protection to more AWS Resources (https://docs.aws.amazon.com/waf/latest/developerguide/configure-new-protection.html).

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 AWS Shield's API operation CreateProtection for usage and error information.

Returned Error Types:

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

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

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

  • LimitsExceededException Exception that indicates that the operation would exceed a limit.

  • ResourceAlreadyExistsException Exception indicating the specified resource already exists. If available, this exception includes details in additional properties.

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

  • ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

  • InvalidParameterException Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/CreateProtection

func (*Shield) CreateProtectionGroup added in v1.35.28 

func (c *Shield) CreateProtectionGroup(input *CreateProtectionGroupInput) (*CreateProtectionGroupOutput, error)

CreateProtectionGroup API operation for AWS Shield.

Creates a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.

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 AWS Shield's API operation CreateProtectionGroup for usage and error information.

Returned Error Types:

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

  • ResourceAlreadyExistsException Exception indicating the specified resource already exists. If available, this exception includes details in additional properties.

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

  • ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

  • InvalidParameterException Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

  • LimitsExceededException Exception that indicates that the operation would exceed a limit.

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/CreateProtectionGroup

func (*Shield) CreateProtectionGroupRequest added in v1.35.28 

func (c *Shield) CreateProtectionGroupRequest(input *CreateProtectionGroupInput) (req *request.Request, output *CreateProtectionGroupOutput)

CreateProtectionGroupRequest generates a "aws/request.Request" representing the client's request for the CreateProtectionGroup 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 CreateProtectionGroup for more information on using the CreateProtectionGroup 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 CreateProtectionGroupRequest method.
req, resp := client.CreateProtectionGroupRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/CreateProtectionGroup

func (*Shield) CreateProtectionGroupWithContext added in v1.35.28 

func (c *Shield) CreateProtectionGroupWithContext(ctx aws.Context, input *CreateProtectionGroupInput, opts ...request.Option) (*CreateProtectionGroupOutput, error)

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

See CreateProtectionGroup 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 (*Shield) CreateProtectionRequest 

func (c *Shield) CreateProtectionRequest(input *CreateProtectionInput) (req *request.Request, output *CreateProtectionOutput)

CreateProtectionRequest generates a "aws/request.Request" representing the client's request for the CreateProtection 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 CreateProtection for more information on using the CreateProtection 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 CreateProtectionRequest method.
req, resp := client.CreateProtectionRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/CreateProtection

func (*Shield) CreateProtectionWithContext added in v1.8.0 

func (c *Shield) CreateProtectionWithContext(ctx aws.Context, input *CreateProtectionInput, opts ...request.Option) (*CreateProtectionOutput, error)

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

See CreateProtection 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 (*Shield) CreateSubscription 

func (c *Shield) CreateSubscription(input *CreateSubscriptionInput) (*CreateSubscriptionOutput, error)

CreateSubscription API operation for AWS Shield.

Activates AWS Shield Advanced for an account.

When you initally create a subscription, your subscription is set to be automatically renewed at the end of the existing subscription period. You can change this by submitting an UpdateSubscription request.

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 AWS Shield's API operation CreateSubscription for usage and error information.

Returned Error Types:

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

  • ResourceAlreadyExistsException Exception indicating the specified resource already exists. If available, this exception includes details in additional properties.

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/CreateSubscription

func (*Shield) CreateSubscriptionRequest 

func (c *Shield) CreateSubscriptionRequest(input *CreateSubscriptionInput) (req *request.Request, output *CreateSubscriptionOutput)

CreateSubscriptionRequest generates a "aws/request.Request" representing the client's request for the CreateSubscription 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 CreateSubscription for more information on using the CreateSubscription 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 CreateSubscriptionRequest method.
req, resp := client.CreateSubscriptionRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/CreateSubscription

func (*Shield) CreateSubscriptionWithContext added in v1.8.0 

func (c *Shield) CreateSubscriptionWithContext(ctx aws.Context, input *CreateSubscriptionInput, opts ...request.Option) (*CreateSubscriptionOutput, error)

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

See CreateSubscription 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 (*Shield) DeleteProtection 

func (c *Shield) DeleteProtection(input *DeleteProtectionInput) (*DeleteProtectionOutput, error)

DeleteProtection API operation for AWS Shield.

Deletes an AWS Shield Advanced Protection.

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 AWS Shield's API operation DeleteProtection for usage and error information.

Returned Error Types:

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

  • ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DeleteProtection

func (*Shield) DeleteProtectionGroup added in v1.35.28 

func (c *Shield) DeleteProtectionGroup(input *DeleteProtectionGroupInput) (*DeleteProtectionGroupOutput, error)

DeleteProtectionGroup API operation for AWS Shield.

Removes the specified protection group.

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 AWS Shield's API operation DeleteProtectionGroup for usage and error information.

Returned Error Types:

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

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

  • ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DeleteProtectionGroup

func (*Shield) DeleteProtectionGroupRequest added in v1.35.28 

func (c *Shield) DeleteProtectionGroupRequest(input *DeleteProtectionGroupInput) (req *request.Request, output *DeleteProtectionGroupOutput)

DeleteProtectionGroupRequest generates a "aws/request.Request" representing the client's request for the DeleteProtectionGroup 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 DeleteProtectionGroup for more information on using the DeleteProtectionGroup 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 DeleteProtectionGroupRequest method.
req, resp := client.DeleteProtectionGroupRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DeleteProtectionGroup

func (*Shield) DeleteProtectionGroupWithContext added in v1.35.28 

func (c *Shield) DeleteProtectionGroupWithContext(ctx aws.Context, input *DeleteProtectionGroupInput, opts ...request.Option) (*DeleteProtectionGroupOutput, error)

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

See DeleteProtectionGroup 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 (*Shield) DeleteProtectionRequest 

func (c *Shield) DeleteProtectionRequest(input *DeleteProtectionInput) (req *request.Request, output *DeleteProtectionOutput)

DeleteProtectionRequest generates a "aws/request.Request" representing the client's request for the DeleteProtection 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 DeleteProtection for more information on using the DeleteProtection 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 DeleteProtectionRequest method.
req, resp := client.DeleteProtectionRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DeleteProtection

func (*Shield) DeleteProtectionWithContext added in v1.8.0 

func (c *Shield) DeleteProtectionWithContext(ctx aws.Context, input *DeleteProtectionInput, opts ...request.Option) (*DeleteProtectionOutput, error)

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

See DeleteProtection 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 (*Shield) DeleteSubscription deprecated 

func (c *Shield) DeleteSubscription(input *DeleteSubscriptionInput) (*DeleteSubscriptionOutput, error)

DeleteSubscription API operation for AWS Shield.

Removes AWS Shield Advanced from an account. AWS Shield Advanced requires a 1-year subscription commitment. You cannot delete a subscription prior to the completion of that commitment.

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 AWS Shield's API operation DeleteSubscription for usage and error information.

Returned Error Types:

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

  • LockedSubscriptionException 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.

  • ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DeleteSubscription

Deprecated: DeleteSubscription has been deprecated

func (*Shield) DeleteSubscriptionRequest deprecated 

func (c *Shield) DeleteSubscriptionRequest(input *DeleteSubscriptionInput) (req *request.Request, output *DeleteSubscriptionOutput)

DeleteSubscriptionRequest generates a "aws/request.Request" representing the client's request for the DeleteSubscription 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 DeleteSubscription for more information on using the DeleteSubscription 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 DeleteSubscriptionRequest method.
req, resp := client.DeleteSubscriptionRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DeleteSubscription

Deprecated: DeleteSubscription has been deprecated

func (*Shield) DeleteSubscriptionWithContext deprecated added in v1.8.0 

func (c *Shield) DeleteSubscriptionWithContext(ctx aws.Context, input *DeleteSubscriptionInput, opts ...request.Option) (*DeleteSubscriptionOutput, error)

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

See DeleteSubscription 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.

Deprecated: DeleteSubscriptionWithContext has been deprecated

func (*Shield) DescribeAttack 

func (c *Shield) DescribeAttack(input *DescribeAttackInput) (*DescribeAttackOutput, error)

DescribeAttack API operation for AWS Shield.

Describes the details of a DDoS attack.

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 AWS Shield's API operation DescribeAttack for usage and error information.

Returned Error Types:

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DescribeAttack

func (*Shield) DescribeAttackRequest 

func (c *Shield) DescribeAttackRequest(input *DescribeAttackInput) (req *request.Request, output *DescribeAttackOutput)

DescribeAttackRequest generates a "aws/request.Request" representing the client's request for the DescribeAttack 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 DescribeAttack for more information on using the DescribeAttack 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 DescribeAttackRequest method.
req, resp := client.DescribeAttackRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DescribeAttack

func (*Shield) DescribeAttackStatistics added in v1.35.28 

func (c *Shield) DescribeAttackStatistics(input *DescribeAttackStatisticsInput) (*DescribeAttackStatisticsOutput, error)

DescribeAttackStatistics API operation for AWS Shield.

Provides information about the number and type of attacks AWS Shield has detected in the last year for all resources that belong to your account, regardless of whether you've defined Shield protections for them. This operation is available to Shield customers as well as to Shield Advanced customers.

The operation returns data for the time range of midnight UTC, one year ago, to midnight UTC, today. For example, if the current time is 2020-10-26 15:39:32 PDT, equal to 2020-10-26 22:39:32 UTC, then the time range for the attack data returned is from 2019-10-26 00:00:00 UTC to 2020-10-26 00:00:00 UTC.

The time range indicates the period covered by the attack statistics data items.

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 AWS Shield's API operation DescribeAttackStatistics for usage and error information.

Returned Error Types:

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

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DescribeAttackStatistics

func (*Shield) DescribeAttackStatisticsRequest added in v1.35.28 

func (c *Shield) DescribeAttackStatisticsRequest(input *DescribeAttackStatisticsInput) (req *request.Request, output *DescribeAttackStatisticsOutput)

DescribeAttackStatisticsRequest generates a "aws/request.Request" representing the client's request for the DescribeAttackStatistics 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 DescribeAttackStatistics for more information on using the DescribeAttackStatistics 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 DescribeAttackStatisticsRequest method.
req, resp := client.DescribeAttackStatisticsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DescribeAttackStatistics

func (*Shield) DescribeAttackStatisticsWithContext added in v1.35.28 

func (c *Shield) DescribeAttackStatisticsWithContext(ctx aws.Context, input *DescribeAttackStatisticsInput, opts ...request.Option) (*DescribeAttackStatisticsOutput, error)

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

See DescribeAttackStatistics 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 (*Shield) DescribeAttackWithContext added in v1.8.0 

func (c *Shield) DescribeAttackWithContext(ctx aws.Context, input *DescribeAttackInput, opts ...request.Option) (*DescribeAttackOutput, error)

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

See DescribeAttack 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 (*Shield) DescribeDRTAccess added in v1.14.1 

func (c *Shield) DescribeDRTAccess(input *DescribeDRTAccessInput) (*DescribeDRTAccessOutput, error)

DescribeDRTAccess API operation for AWS Shield.

Returns the current role and list of Amazon S3 log buckets used by the DDoS Response Team (DRT) to access your AWS account while assisting with attack mitigation.

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 AWS Shield's API operation DescribeDRTAccess for usage and error information.

Returned Error Types:

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

  • ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DescribeDRTAccess

func (*Shield) DescribeDRTAccessRequest added in v1.14.1 

func (c *Shield) DescribeDRTAccessRequest(input *DescribeDRTAccessInput) (req *request.Request, output *DescribeDRTAccessOutput)

DescribeDRTAccessRequest generates a "aws/request.Request" representing the client's request for the DescribeDRTAccess 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 DescribeDRTAccess for more information on using the DescribeDRTAccess 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 DescribeDRTAccessRequest method.
req, resp := client.DescribeDRTAccessRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DescribeDRTAccess

func (*Shield) DescribeDRTAccessWithContext added in v1.14.1 

func (c *Shield) DescribeDRTAccessWithContext(ctx aws.Context, input *DescribeDRTAccessInput, opts ...request.Option) (*DescribeDRTAccessOutput, error)

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

See DescribeDRTAccess 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 (*Shield) DescribeEmergencyContactSettings added in v1.14.1 

func (c *Shield) DescribeEmergencyContactSettings(input *DescribeEmergencyContactSettingsInput) (*DescribeEmergencyContactSettingsOutput, error)

DescribeEmergencyContactSettings API operation for AWS Shield.

A list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you if you have proactive engagement enabled, for escalations to the DRT and to initiate proactive customer support.

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 AWS Shield's API operation DescribeEmergencyContactSettings for usage and error information.

Returned Error Types:

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

  • ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DescribeEmergencyContactSettings

func (*Shield) DescribeEmergencyContactSettingsRequest added in v1.14.1 

func (c *Shield) DescribeEmergencyContactSettingsRequest(input *DescribeEmergencyContactSettingsInput) (req *request.Request, output *DescribeEmergencyContactSettingsOutput)

DescribeEmergencyContactSettingsRequest generates a "aws/request.Request" representing the client's request for the DescribeEmergencyContactSettings 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 DescribeEmergencyContactSettings for more information on using the DescribeEmergencyContactSettings 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 DescribeEmergencyContactSettingsRequest method.
req, resp := client.DescribeEmergencyContactSettingsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DescribeEmergencyContactSettings

func (*Shield) DescribeEmergencyContactSettingsWithContext added in v1.14.1 

func (c *Shield) DescribeEmergencyContactSettingsWithContext(ctx aws.Context, input *DescribeEmergencyContactSettingsInput, opts ...request.Option) (*DescribeEmergencyContactSettingsOutput, error)

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

See DescribeEmergencyContactSettings 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 (*Shield) DescribeProtection 

func (c *Shield) DescribeProtection(input *DescribeProtectionInput) (*DescribeProtectionOutput, error)

DescribeProtection API operation for AWS Shield.

Lists the details of a Protection object.

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 AWS Shield's API operation DescribeProtection for usage and error information.

Returned Error Types:

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

  • InvalidParameterException Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

  • ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DescribeProtection

func (*Shield) DescribeProtectionGroup added in v1.35.28 

func (c *Shield) DescribeProtectionGroup(input *DescribeProtectionGroupInput) (*DescribeProtectionGroupOutput, error)

DescribeProtectionGroup API operation for AWS Shield.

Returns the specification for the specified protection group.

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 AWS Shield's API operation DescribeProtectionGroup for usage and error information.

Returned Error Types:

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

  • ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DescribeProtectionGroup

func (*Shield) DescribeProtectionGroupRequest added in v1.35.28 

func (c *Shield) DescribeProtectionGroupRequest(input *DescribeProtectionGroupInput) (req *request.Request, output *DescribeProtectionGroupOutput)

DescribeProtectionGroupRequest generates a "aws/request.Request" representing the client's request for the DescribeProtectionGroup 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 DescribeProtectionGroup for more information on using the DescribeProtectionGroup 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 DescribeProtectionGroupRequest method.
req, resp := client.DescribeProtectionGroupRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DescribeProtectionGroup

func (*Shield) DescribeProtectionGroupWithContext added in v1.35.28 

func (c *Shield) DescribeProtectionGroupWithContext(ctx aws.Context, input *DescribeProtectionGroupInput, opts ...request.Option) (*DescribeProtectionGroupOutput, error)

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

See DescribeProtectionGroup 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 (*Shield) DescribeProtectionRequest 

func (c *Shield) DescribeProtectionRequest(input *DescribeProtectionInput) (req *request.Request, output *DescribeProtectionOutput)

DescribeProtectionRequest generates a "aws/request.Request" representing the client's request for the DescribeProtection 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 DescribeProtection for more information on using the DescribeProtection 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 DescribeProtectionRequest method.
req, resp := client.DescribeProtectionRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DescribeProtection

func (*Shield) DescribeProtectionWithContext added in v1.8.0 

func (c *Shield) DescribeProtectionWithContext(ctx aws.Context, input *DescribeProtectionInput, opts ...request.Option) (*DescribeProtectionOutput, error)

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

See DescribeProtection 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 (*Shield) DescribeSubscription 

func (c *Shield) DescribeSubscription(input *DescribeSubscriptionInput) (*DescribeSubscriptionOutput, error)

DescribeSubscription API operation for AWS Shield.

Provides details about the AWS Shield Advanced subscription for an account.

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 AWS Shield's API operation DescribeSubscription for usage and error information.

Returned Error Types:

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

  • ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DescribeSubscription

func (*Shield) DescribeSubscriptionRequest 

func (c *Shield) DescribeSubscriptionRequest(input *DescribeSubscriptionInput) (req *request.Request, output *DescribeSubscriptionOutput)

DescribeSubscriptionRequest generates a "aws/request.Request" representing the client's request for the DescribeSubscription 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 DescribeSubscription for more information on using the DescribeSubscription 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 DescribeSubscriptionRequest method.
req, resp := client.DescribeSubscriptionRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DescribeSubscription

func (*Shield) DescribeSubscriptionWithContext added in v1.8.0 

func (c *Shield) DescribeSubscriptionWithContext(ctx aws.Context, input *DescribeSubscriptionInput, opts ...request.Option) (*DescribeSubscriptionOutput, error)

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

See DescribeSubscription 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 (*Shield) DisableProactiveEngagement added in v1.31.13 

func (c *Shield) DisableProactiveEngagement(input *DisableProactiveEngagementInput) (*DisableProactiveEngagementOutput, error)

DisableProactiveEngagement API operation for AWS Shield.

Removes authorization from the DDoS Response Team (DRT) to notify contacts about escalations to the DRT and to initiate proactive customer support.

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 AWS Shield's API operation DisableProactiveEngagement for usage and error information.

Returned Error Types:

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

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

  • InvalidParameterException Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

  • ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DisableProactiveEngagement

func (*Shield) DisableProactiveEngagementRequest added in v1.31.13 

func (c *Shield) DisableProactiveEngagementRequest(input *DisableProactiveEngagementInput) (req *request.Request, output *DisableProactiveEngagementOutput)

DisableProactiveEngagementRequest generates a "aws/request.Request" representing the client's request for the DisableProactiveEngagement 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 DisableProactiveEngagement for more information on using the DisableProactiveEngagement 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 DisableProactiveEngagementRequest method.
req, resp := client.DisableProactiveEngagementRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DisableProactiveEngagement

func (*Shield) DisableProactiveEngagementWithContext added in v1.31.13 

func (c *Shield) DisableProactiveEngagementWithContext(ctx aws.Context, input *DisableProactiveEngagementInput, opts ...request.Option) (*DisableProactiveEngagementOutput, error)

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

See DisableProactiveEngagement 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 (*Shield) DisassociateDRTLogBucket added in v1.14.1 

func (c *Shield) DisassociateDRTLogBucket(input *DisassociateDRTLogBucketInput) (*DisassociateDRTLogBucketOutput, error)

DisassociateDRTLogBucket API operation for AWS Shield.

Removes the DDoS Response Team's (DRT) access to the specified Amazon S3 bucket containing your AWS WAF logs.

To make a DisassociateDRTLogBucket request, you must be subscribed to the Business Support plan (https://aws.amazon.com/premiumsupport/business-support/) or the Enterprise Support plan (https://aws.amazon.com/premiumsupport/enterprise-support/). However, if you are not subscribed to one of these support plans, but had been previously and had granted the DRT access to your account, you can submit a DisassociateDRTLogBucket request to remove this access.

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 AWS Shield's API operation DisassociateDRTLogBucket for usage and error information.

Returned Error Types:

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

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

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

  • AccessDeniedForDependencyException 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).

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

  • ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DisassociateDRTLogBucket

func (*Shield) DisassociateDRTLogBucketRequest added in v1.14.1 

func (c *Shield) DisassociateDRTLogBucketRequest(input *DisassociateDRTLogBucketInput) (req *request.Request, output *DisassociateDRTLogBucketOutput)

DisassociateDRTLogBucketRequest generates a "aws/request.Request" representing the client's request for the DisassociateDRTLogBucket 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 DisassociateDRTLogBucket for more information on using the DisassociateDRTLogBucket 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 DisassociateDRTLogBucketRequest method.
req, resp := client.DisassociateDRTLogBucketRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DisassociateDRTLogBucket

func (*Shield) DisassociateDRTLogBucketWithContext added in v1.14.1 

func (c *Shield) DisassociateDRTLogBucketWithContext(ctx aws.Context, input *DisassociateDRTLogBucketInput, opts ...request.Option) (*DisassociateDRTLogBucketOutput, error)

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

See DisassociateDRTLogBucket 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 (*Shield) DisassociateDRTRole added in v1.14.1 

func (c *Shield) DisassociateDRTRole(input *DisassociateDRTRoleInput) (*DisassociateDRTRoleOutput, error)

DisassociateDRTRole API operation for AWS Shield.

Removes the DDoS Response Team's (DRT) access to your AWS account.

To make a DisassociateDRTRole request, you must be subscribed to the Business Support plan (https://aws.amazon.com/premiumsupport/business-support/) or the Enterprise Support plan (https://aws.amazon.com/premiumsupport/enterprise-support/). However, if you are not subscribed to one of these support plans, but had been previously and had granted the DRT access to your account, you can submit a DisassociateDRTRole request to remove this access.

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 AWS Shield's API operation DisassociateDRTRole for usage and error information.

Returned Error Types:

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

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

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

  • ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DisassociateDRTRole

func (*Shield) DisassociateDRTRoleRequest added in v1.14.1 

func (c *Shield) DisassociateDRTRoleRequest(input *DisassociateDRTRoleInput) (req *request.Request, output *DisassociateDRTRoleOutput)

DisassociateDRTRoleRequest generates a "aws/request.Request" representing the client's request for the DisassociateDRTRole 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 DisassociateDRTRole for more information on using the DisassociateDRTRole 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 DisassociateDRTRoleRequest method.
req, resp := client.DisassociateDRTRoleRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DisassociateDRTRole

func (*Shield) DisassociateDRTRoleWithContext added in v1.14.1 

func (c *Shield) DisassociateDRTRoleWithContext(ctx aws.Context, input *DisassociateDRTRoleInput, opts ...request.Option) (*DisassociateDRTRoleOutput, error)

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

See DisassociateDRTRole 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 (*Shield) DisassociateHealthCheck added in v1.29.3 

func (c *Shield) DisassociateHealthCheck(input *DisassociateHealthCheckInput) (*DisassociateHealthCheckOutput, error)

DisassociateHealthCheck API operation for AWS Shield.

Removes health-based detection from the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your AWS resource to improve responsiveness and accuracy in attack detection and mitigation.

You define the health check in Route 53 and then associate or disassociate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection (https://docs.aws.amazon.com/waf/latest/developerguide/ddos-overview.html#ddos-advanced-health-check-option) in the AWS WAF and AWS Shield Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/).

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 AWS Shield's API operation DisassociateHealthCheck for usage and error information.

Returned Error Types:

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

  • InvalidParameterException Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

  • ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DisassociateHealthCheck

func (*Shield) DisassociateHealthCheckRequest added in v1.29.3 

func (c *Shield) DisassociateHealthCheckRequest(input *DisassociateHealthCheckInput) (req *request.Request, output *DisassociateHealthCheckOutput)

DisassociateHealthCheckRequest generates a "aws/request.Request" representing the client's request for the DisassociateHealthCheck 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 DisassociateHealthCheck for more information on using the DisassociateHealthCheck 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 DisassociateHealthCheckRequest method.
req, resp := client.DisassociateHealthCheckRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DisassociateHealthCheck

func (*Shield) DisassociateHealthCheckWithContext added in v1.29.3 

func (c *Shield) DisassociateHealthCheckWithContext(ctx aws.Context, input *DisassociateHealthCheckInput, opts ...request.Option) (*DisassociateHealthCheckOutput, error)

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

See DisassociateHealthCheck 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 (*Shield) EnableProactiveEngagement added in v1.31.13 

func (c *Shield) EnableProactiveEngagement(input *EnableProactiveEngagementInput) (*EnableProactiveEngagementOutput, error)

EnableProactiveEngagement API operation for AWS Shield.

Authorizes the DDoS Response Team (DRT) to use email and phone to notify contacts about escalations to the DRT and to initiate proactive customer support.

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 AWS Shield's API operation EnableProactiveEngagement for usage and error information.

Returned Error Types:

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

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

  • InvalidParameterException Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

  • ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/EnableProactiveEngagement

func (*Shield) EnableProactiveEngagementRequest added in v1.31.13 

func (c *Shield) EnableProactiveEngagementRequest(input *EnableProactiveEngagementInput) (req *request.Request, output *EnableProactiveEngagementOutput)

EnableProactiveEngagementRequest generates a "aws/request.Request" representing the client's request for the EnableProactiveEngagement 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 EnableProactiveEngagement for more information on using the EnableProactiveEngagement 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 EnableProactiveEngagementRequest method.
req, resp := client.EnableProactiveEngagementRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/EnableProactiveEngagement

func (*Shield) EnableProactiveEngagementWithContext added in v1.31.13 

func (c *Shield) EnableProactiveEngagementWithContext(ctx aws.Context, input *EnableProactiveEngagementInput, opts ...request.Option) (*EnableProactiveEngagementOutput, error)

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

See EnableProactiveEngagement 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 (*Shield) GetSubscriptionState added in v1.12.32 

func (c *Shield) GetSubscriptionState(input *GetSubscriptionStateInput) (*GetSubscriptionStateOutput, error)

GetSubscriptionState API operation for AWS Shield.

Returns the SubscriptionState, either Active or Inactive.

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 AWS Shield's API operation GetSubscriptionState for usage and error information.

Returned Error Types:

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

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/GetSubscriptionState

func (*Shield) GetSubscriptionStateRequest added in v1.12.32 

func (c *Shield) GetSubscriptionStateRequest(input *GetSubscriptionStateInput) (req *request.Request, output *GetSubscriptionStateOutput)

GetSubscriptionStateRequest generates a "aws/request.Request" representing the client's request for the GetSubscriptionState 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 GetSubscriptionState for more information on using the GetSubscriptionState 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 GetSubscriptionStateRequest method.
req, resp := client.GetSubscriptionStateRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/GetSubscriptionState

func (*Shield) GetSubscriptionStateWithContext added in v1.12.32 

func (c *Shield) GetSubscriptionStateWithContext(ctx aws.Context, input *GetSubscriptionStateInput, opts ...request.Option) (*GetSubscriptionStateOutput, error)

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

See GetSubscriptionState 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 (*Shield) ListAttacks 

func (c *Shield) ListAttacks(input *ListAttacksInput) (*ListAttacksOutput, error)

ListAttacks API operation for AWS Shield.

Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.

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 AWS Shield's API operation ListAttacks for usage and error information.

Returned Error Types:

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

  • InvalidParameterException Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/ListAttacks

func (*Shield) ListAttacksPages added in v1.31.13 

func (c *Shield) ListAttacksPages(input *ListAttacksInput, fn func(*ListAttacksOutput, bool) bool) error

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

See ListAttacks 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 ListAttacks operation.
pageNum := 0
err := client.ListAttacksPages(params,
    func(page *shield.ListAttacksOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Shield) ListAttacksPagesWithContext added in v1.31.13 

func (c *Shield) ListAttacksPagesWithContext(ctx aws.Context, input *ListAttacksInput, fn func(*ListAttacksOutput, bool) bool, opts ...request.Option) error

ListAttacksPagesWithContext same as ListAttacksPages 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 (*Shield) ListAttacksRequest 

func (c *Shield) ListAttacksRequest(input *ListAttacksInput) (req *request.Request, output *ListAttacksOutput)

ListAttacksRequest generates a "aws/request.Request" representing the client's request for the ListAttacks 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 ListAttacks for more information on using the ListAttacks 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 ListAttacksRequest method.
req, resp := client.ListAttacksRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/ListAttacks

func (*Shield) ListAttacksWithContext added in v1.8.0 

func (c *Shield) ListAttacksWithContext(ctx aws.Context, input *ListAttacksInput, opts ...request.Option) (*ListAttacksOutput, error)

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

See ListAttacks 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 (*Shield) ListProtectionGroups added in v1.35.28 

func (c *Shield) ListProtectionGroups(input *ListProtectionGroupsInput) (*ListProtectionGroupsOutput, error)

ListProtectionGroups API operation for AWS Shield.

Retrieves the ProtectionGroup objects for the account.

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 AWS Shield's API operation ListProtectionGroups for usage and error information.

Returned Error Types:

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

  • ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

  • InvalidPaginationTokenException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/ListProtectionGroups

func (*Shield) ListProtectionGroupsPages added in v1.35.28 

func (c *Shield) ListProtectionGroupsPages(input *ListProtectionGroupsInput, fn func(*ListProtectionGroupsOutput, bool) bool) error

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

See ListProtectionGroups 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 ListProtectionGroups operation.
pageNum := 0
err := client.ListProtectionGroupsPages(params,
    func(page *shield.ListProtectionGroupsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Shield) ListProtectionGroupsPagesWithContext added in v1.35.28 

func (c *Shield) ListProtectionGroupsPagesWithContext(ctx aws.Context, input *ListProtectionGroupsInput, fn func(*ListProtectionGroupsOutput, bool) bool, opts ...request.Option) error

ListProtectionGroupsPagesWithContext same as ListProtectionGroupsPages 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 (*Shield) ListProtectionGroupsRequest added in v1.35.28 

func (c *Shield) ListProtectionGroupsRequest(input *ListProtectionGroupsInput) (req *request.Request, output *ListProtectionGroupsOutput)

ListProtectionGroupsRequest generates a "aws/request.Request" representing the client's request for the ListProtectionGroups 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 ListProtectionGroups for more information on using the ListProtectionGroups 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 ListProtectionGroupsRequest method.
req, resp := client.ListProtectionGroupsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/ListProtectionGroups

func (*Shield) ListProtectionGroupsWithContext added in v1.35.28 

func (c *Shield) ListProtectionGroupsWithContext(ctx aws.Context, input *ListProtectionGroupsInput, opts ...request.Option) (*ListProtectionGroupsOutput, error)

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

See ListProtectionGroups 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 (*Shield) ListProtections 

func (c *Shield) ListProtections(input *ListProtectionsInput) (*ListProtectionsOutput, error)

ListProtections API operation for AWS Shield.

Lists all Protection objects for the account.

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 AWS Shield's API operation ListProtections for usage and error information.

Returned Error Types:

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

  • ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

  • InvalidPaginationTokenException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/ListProtections

func (*Shield) ListProtectionsPages added in v1.31.13 

func (c *Shield) ListProtectionsPages(input *ListProtectionsInput, fn func(*ListProtectionsOutput, bool) bool) error

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

See ListProtections 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 ListProtections operation.
pageNum := 0
err := client.ListProtectionsPages(params,
    func(page *shield.ListProtectionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Shield) ListProtectionsPagesWithContext added in v1.31.13 

func (c *Shield) ListProtectionsPagesWithContext(ctx aws.Context, input *ListProtectionsInput, fn func(*ListProtectionsOutput, bool) bool, opts ...request.Option) error

ListProtectionsPagesWithContext same as ListProtectionsPages 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 (*Shield) ListProtectionsRequest 

func (c *Shield) ListProtectionsRequest(input *ListProtectionsInput) (req *request.Request, output *ListProtectionsOutput)

ListProtectionsRequest generates a "aws/request.Request" representing the client's request for the ListProtections 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 ListProtections for more information on using the ListProtections 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 ListProtectionsRequest method.
req, resp := client.ListProtectionsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/ListProtections

func (*Shield) ListProtectionsWithContext added in v1.8.0 

func (c *Shield) ListProtectionsWithContext(ctx aws.Context, input *ListProtectionsInput, opts ...request.Option) (*ListProtectionsOutput, error)

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

See ListProtections 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 (*Shield) ListResourcesInProtectionGroup added in v1.35.28 

func (c *Shield) ListResourcesInProtectionGroup(input *ListResourcesInProtectionGroupInput) (*ListResourcesInProtectionGroupOutput, error)

ListResourcesInProtectionGroup API operation for AWS Shield.

Retrieves the resources that are included in the protection group.

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 AWS Shield's API operation ListResourcesInProtectionGroup for usage and error information.

Returned Error Types:

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

  • ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

  • InvalidPaginationTokenException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/ListResourcesInProtectionGroup

func (*Shield) ListResourcesInProtectionGroupPages added in v1.35.28 

func (c *Shield) ListResourcesInProtectionGroupPages(input *ListResourcesInProtectionGroupInput, fn func(*ListResourcesInProtectionGroupOutput, bool) bool) error

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

See ListResourcesInProtectionGroup 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 ListResourcesInProtectionGroup operation.
pageNum := 0
err := client.ListResourcesInProtectionGroupPages(params,
    func(page *shield.ListResourcesInProtectionGroupOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Shield) ListResourcesInProtectionGroupPagesWithContext added in v1.35.28 

func (c *Shield) ListResourcesInProtectionGroupPagesWithContext(ctx aws.Context, input *ListResourcesInProtectionGroupInput, fn func(*ListResourcesInProtectionGroupOutput, bool) bool, opts ...request.Option) error

ListResourcesInProtectionGroupPagesWithContext same as ListResourcesInProtectionGroupPages 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 (*Shield) ListResourcesInProtectionGroupRequest added in v1.35.28 

func (c *Shield) ListResourcesInProtectionGroupRequest(input *ListResourcesInProtectionGroupInput) (req *request.Request, output *ListResourcesInProtectionGroupOutput)

ListResourcesInProtectionGroupRequest generates a "aws/request.Request" representing the client's request for the ListResourcesInProtectionGroup 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 ListResourcesInProtectionGroup for more information on using the ListResourcesInProtectionGroup 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 ListResourcesInProtectionGroupRequest method.
req, resp := client.ListResourcesInProtectionGroupRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/ListResourcesInProtectionGroup

func (*Shield) ListResourcesInProtectionGroupWithContext added in v1.35.28 

func (c *Shield) ListResourcesInProtectionGroupWithContext(ctx aws.Context, input *ListResourcesInProtectionGroupInput, opts ...request.Option) (*ListResourcesInProtectionGroupOutput, error)

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

See ListResourcesInProtectionGroup 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 (*Shield) ListTagsForResource added in v1.37.25 

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

ListTagsForResource API operation for AWS Shield.

Gets information about AWS tags for a specified Amazon Resource Name (ARN) in AWS Shield.

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 AWS Shield's API operation ListTagsForResource for usage and error information.

Returned Error Types:

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

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

  • ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/ListTagsForResource

func (*Shield) ListTagsForResourceRequest added in v1.37.25 

func (c *Shield) 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/shield-2016-06-02/ListTagsForResource

func (*Shield) ListTagsForResourceWithContext added in v1.37.25 

func (c *Shield) 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 (*Shield) TagResource added in v1.37.25 

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

TagResource API operation for AWS Shield.

Adds or updates tags for a resource in AWS Shield.

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 AWS Shield's API operation TagResource for usage and error information.

Returned Error Types:

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

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

  • InvalidParameterException Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

  • ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/TagResource

func (*Shield) TagResourceRequest added in v1.37.25 

func (c *Shield) 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/shield-2016-06-02/TagResource

func (*Shield) TagResourceWithContext added in v1.37.25 

func (c *Shield) 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 (*Shield) UntagResource added in v1.37.25 

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

UntagResource API operation for AWS Shield.

Removes tags from a resource in AWS Shield.

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 AWS Shield's API operation UntagResource for usage and error information.

Returned Error Types:

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

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

  • InvalidParameterException Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

  • ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/UntagResource

func (*Shield) UntagResourceRequest added in v1.37.25 

func (c *Shield) 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/shield-2016-06-02/UntagResource

func (*Shield) UntagResourceWithContext added in v1.37.25 

func (c *Shield) 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 (*Shield) UpdateEmergencyContactSettings added in v1.14.1 

func (c *Shield) UpdateEmergencyContactSettings(input *UpdateEmergencyContactSettingsInput) (*UpdateEmergencyContactSettingsOutput, error)

UpdateEmergencyContactSettings API operation for AWS Shield.

Updates the details of the list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you if you have proactive engagement enabled, for escalations to the DRT and to initiate proactive customer support.

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 AWS Shield's API operation UpdateEmergencyContactSettings for usage and error information.

Returned Error Types:

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

  • InvalidParameterException Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

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

  • ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/UpdateEmergencyContactSettings

func (*Shield) UpdateEmergencyContactSettingsRequest added in v1.14.1 

func (c *Shield) UpdateEmergencyContactSettingsRequest(input *UpdateEmergencyContactSettingsInput) (req *request.Request, output *UpdateEmergencyContactSettingsOutput)

UpdateEmergencyContactSettingsRequest generates a "aws/request.Request" representing the client's request for the UpdateEmergencyContactSettings 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 UpdateEmergencyContactSettings for more information on using the UpdateEmergencyContactSettings 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 UpdateEmergencyContactSettingsRequest method.
req, resp := client.UpdateEmergencyContactSettingsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/UpdateEmergencyContactSettings

func (*Shield) UpdateEmergencyContactSettingsWithContext added in v1.14.1 

func (c *Shield) UpdateEmergencyContactSettingsWithContext(ctx aws.Context, input *UpdateEmergencyContactSettingsInput, opts ...request.Option) (*UpdateEmergencyContactSettingsOutput, error)

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

See UpdateEmergencyContactSettings 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 (*Shield) UpdateProtectionGroup added in v1.35.28 

func (c *Shield) UpdateProtectionGroup(input *UpdateProtectionGroupInput) (*UpdateProtectionGroupOutput, error)

UpdateProtectionGroup API operation for AWS Shield.

Updates an existing protection group. A protection group is a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.

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 AWS Shield's API operation UpdateProtectionGroup for usage and error information.

Returned Error Types:

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

  • ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

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

  • InvalidParameterException Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/UpdateProtectionGroup

func (*Shield) UpdateProtectionGroupRequest added in v1.35.28 

func (c *Shield) UpdateProtectionGroupRequest(input *UpdateProtectionGroupInput) (req *request.Request, output *UpdateProtectionGroupOutput)

UpdateProtectionGroupRequest generates a "aws/request.Request" representing the client's request for the UpdateProtectionGroup 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 UpdateProtectionGroup for more information on using the UpdateProtectionGroup 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 UpdateProtectionGroupRequest method.
req, resp := client.UpdateProtectionGroupRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/UpdateProtectionGroup

func (*Shield) UpdateProtectionGroupWithContext added in v1.35.28 

func (c *Shield) UpdateProtectionGroupWithContext(ctx aws.Context, input *UpdateProtectionGroupInput, opts ...request.Option) (*UpdateProtectionGroupOutput, error)

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

See UpdateProtectionGroup 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 (*Shield) UpdateSubscription added in v1.14.1 

func (c *Shield) UpdateSubscription(input *UpdateSubscriptionInput) (*UpdateSubscriptionOutput, error)

UpdateSubscription API operation for AWS Shield.

Updates the details of an existing subscription. Only enter values for parameters you want to change. Empty parameters are not updated.

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 AWS Shield's API operation UpdateSubscription for usage and error information.

Returned Error Types:

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

  • LockedSubscriptionException 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.

  • ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

  • InvalidParameterException Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/UpdateSubscription

func (*Shield) UpdateSubscriptionRequest added in v1.14.1 

func (c *Shield) UpdateSubscriptionRequest(input *UpdateSubscriptionInput) (req *request.Request, output *UpdateSubscriptionOutput)

UpdateSubscriptionRequest generates a "aws/request.Request" representing the client's request for the UpdateSubscription 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 UpdateSubscription for more information on using the UpdateSubscription 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 UpdateSubscriptionRequest method.
req, resp := client.UpdateSubscriptionRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/UpdateSubscription

func (*Shield) UpdateSubscriptionWithContext added in v1.14.1 

func (c *Shield) UpdateSubscriptionWithContext(ctx aws.Context, input *UpdateSubscriptionInput, opts ...request.Option) (*UpdateSubscriptionOutput, error)

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

See UpdateSubscription 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 SubResourceSummary 

type SubResourceSummary struct {

	// The list of attack types and associated counters.
	AttackVectors []*SummarizedAttackVector `type:"list"`

	// The counters that describe the details of the attack.
	Counters []*SummarizedCounter `type:"list"`

	// The unique identifier (ID) of the SubResource.
	Id *string `type:"string"`

	// The SubResource type.
	Type *string `type:"string" enum:"SubResourceType"`
	// contains filtered or unexported fields
}

The attack information for the specified SubResource.

func (SubResourceSummary) GoString 

func (s SubResourceSummary) GoString() string

GoString returns the string representation

func (*SubResourceSummary) SetAttackVectors 

func (s *SubResourceSummary) SetAttackVectors(v []*SummarizedAttackVector) *SubResourceSummary

SetAttackVectors sets the AttackVectors field's value.

func (*SubResourceSummary) SetCounters 

func (s *SubResourceSummary) SetCounters(v []*SummarizedCounter) *SubResourceSummary

SetCounters sets the Counters field's value.

func (*SubResourceSummary) SetId 

func (s *SubResourceSummary) SetId(v string) *SubResourceSummary

SetId sets the Id field's value.

func (*SubResourceSummary) SetType 

func (s *SubResourceSummary) SetType(v string) *SubResourceSummary

SetType sets the Type field's value.

func (SubResourceSummary) String 

func (s SubResourceSummary) String() string

String returns the string representation

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 *string `type:"string" enum:"AutoRenew"`

	// The date and time your subscription will end.
	EndTime *time.Time `type:"timestamp"`

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

	// 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 *string `type:"string" enum:"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 `type:"timestamp"`

	// The ARN (Amazon Resource Name) of the subscription.
	SubscriptionArn *string `min:"1" type:"string"`

	// Limits settings for your subscription.
	//
	// SubscriptionLimits is a required field
	SubscriptionLimits *SubscriptionLimits `type:"structure" required:"true"`

	// The length, in seconds, of the AWS Shield Advanced subscription for the account.
	TimeCommitmentInSeconds *int64 `type:"long"`
	// contains filtered or unexported fields
}

Information about the AWS Shield Advanced subscription for an account.

func (Subscription) GoString 

func (s Subscription) GoString() string

GoString returns the string representation

func (*Subscription) SetAutoRenew added in v1.14.1 

func (s *Subscription) SetAutoRenew(v string) *Subscription

SetAutoRenew sets the AutoRenew field's value.

func (*Subscription) SetEndTime added in v1.14.1 

func (s *Subscription) SetEndTime(v time.Time) *Subscription

SetEndTime sets the EndTime field's value.

func (*Subscription) SetLimits added in v1.14.1 

func (s *Subscription) SetLimits(v []*Limit) *Subscription

SetLimits sets the Limits field's value.

func (*Subscription) SetProactiveEngagementStatus added in v1.31.13 

func (s *Subscription) SetProactiveEngagementStatus(v string) *Subscription

SetProactiveEngagementStatus sets the ProactiveEngagementStatus field's value.

func (*Subscription) SetStartTime 

func (s *Subscription) SetStartTime(v time.Time) *Subscription

SetStartTime sets the StartTime field's value.

func (*Subscription) SetSubscriptionArn added in v1.37.25 

func (s *Subscription) SetSubscriptionArn(v string) *Subscription

SetSubscriptionArn sets the SubscriptionArn field's value.

func (*Subscription) SetSubscriptionLimits added in v1.35.28 

func (s *Subscription) SetSubscriptionLimits(v *SubscriptionLimits) *Subscription

SetSubscriptionLimits sets the SubscriptionLimits field's value.

func (*Subscription) SetTimeCommitmentInSeconds 

func (s *Subscription) SetTimeCommitmentInSeconds(v int64) *Subscription

SetTimeCommitmentInSeconds sets the TimeCommitmentInSeconds field's value.

func (Subscription) String 

func (s Subscription) String() string

String returns the string representation

type SubscriptionLimits added in v1.35.28 

type SubscriptionLimits struct {

	// Limits settings on protection groups for your subscription.
	//
	// ProtectionGroupLimits is a required field
	ProtectionGroupLimits *ProtectionGroupLimits `type:"structure" required:"true"`

	// Limits settings on protections for your subscription.
	//
	// ProtectionLimits is a required field
	ProtectionLimits *ProtectionLimits `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Limits settings for your subscription.

func (SubscriptionLimits) GoString added in v1.35.28 

func (s SubscriptionLimits) GoString() string

GoString returns the string representation

func (*SubscriptionLimits) SetProtectionGroupLimits added in v1.35.28 

func (s *SubscriptionLimits) SetProtectionGroupLimits(v *ProtectionGroupLimits) *SubscriptionLimits

SetProtectionGroupLimits sets the ProtectionGroupLimits field's value.

func (*SubscriptionLimits) SetProtectionLimits added in v1.35.28 

func (s *SubscriptionLimits) SetProtectionLimits(v *ProtectionLimits) *SubscriptionLimits

SetProtectionLimits sets the ProtectionLimits field's value.

func (SubscriptionLimits) String added in v1.35.28 

func (s SubscriptionLimits) String() string

String returns the string representation

type SummarizedAttackVector 

type SummarizedAttackVector struct {

	// The list of counters that describe the details of the attack.
	VectorCounters []*SummarizedCounter `type:"list"`

	// The attack type, for example, SNMP reflection or SYN flood.
	//
	// VectorType is a required field
	VectorType *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

A summary of information about the attack.

func (SummarizedAttackVector) GoString 

func (s SummarizedAttackVector) GoString() string

GoString returns the string representation

func (*SummarizedAttackVector) SetVectorCounters 

func (s *SummarizedAttackVector) SetVectorCounters(v []*SummarizedCounter) *SummarizedAttackVector

SetVectorCounters sets the VectorCounters field's value.

func (*SummarizedAttackVector) SetVectorType 

func (s *SummarizedAttackVector) SetVectorType(v string) *SummarizedAttackVector

SetVectorType sets the VectorType field's value.

func (SummarizedAttackVector) String 

func (s SummarizedAttackVector) String() string

String returns the string representation

type SummarizedCounter 

type SummarizedCounter struct {

	// The average value of the counter for a specified time period.
	Average *float64 `type:"double"`

	// The maximum value of the counter for a specified time period.
	Max *float64 `type:"double"`

	// The number of counters for a specified time period.
	N *int64 `type:"integer"`

	// The counter name.
	Name *string `type:"string"`

	// The total of counter values for a specified time period.
	Sum *float64 `type:"double"`

	// The unit of the counters.
	Unit *string `type:"string"`
	// contains filtered or unexported fields
}

The counter that describes a DDoS attack.

func (SummarizedCounter) GoString 

func (s SummarizedCounter) GoString() string

GoString returns the string representation

func (*SummarizedCounter) SetAverage 

func (s *SummarizedCounter) SetAverage(v float64) *SummarizedCounter

SetAverage sets the Average field's value.

func (*SummarizedCounter) SetMax 

func (s *SummarizedCounter) SetMax(v float64) *SummarizedCounter

SetMax sets the Max field's value.

func (*SummarizedCounter) SetN 

func (s *SummarizedCounter) SetN(v int64) *SummarizedCounter

SetN sets the N field's value.

func (*SummarizedCounter) SetName 

func (s *SummarizedCounter) SetName(v string) *SummarizedCounter

SetName sets the Name field's value.

func (*SummarizedCounter) SetSum 

func (s *SummarizedCounter) SetSum(v float64) *SummarizedCounter

SetSum sets the Sum field's value.

func (*SummarizedCounter) SetUnit 

func (s *SummarizedCounter) SetUnit(v string) *SummarizedCounter

SetUnit sets the Unit field's value.

func (SummarizedCounter) String 

func (s SummarizedCounter) String() string

String returns the string representation

type Tag added in v1.37.25 

type Tag struct {

	// Part of the key:value pair that defines a tag. You can use a tag key to describe
	// a category of information, such as "customer." Tag keys are case-sensitive.
	Key *string `min:"1" type:"string"`

	// Part of the key:value pair that defines a tag. You can use a tag value to
	// describe a specific value within a category, such as "companyA" or "companyB."
	// Tag values are case-sensitive.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

A tag associated with an AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as "environment", and the tag value represents a specific value within that category, such as "test," "development," or "production". Or you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.

func (Tag) GoString added in v1.37.25 

func (s Tag) GoString() string

GoString returns the string representation

func (*Tag) SetKey added in v1.37.25 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.37.25 

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String added in v1.37.25 

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate added in v1.37.25 

func (s *Tag) Validate() error

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

type TagResourceInput added in v1.37.25 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource that you want to add or update
	// tags for.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

	// The tags that you want to modify or add to the resource.
	//
	// Tags is a required field
	Tags []*Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString added in v1.37.25 

func (s TagResourceInput) GoString() string

GoString returns the string representation

func (*TagResourceInput) SetResourceARN added in v1.37.25 

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

SetResourceARN sets the ResourceARN field's value.

func (*TagResourceInput) SetTags added in v1.37.25 

func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String added in v1.37.25 

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate added in v1.37.25 

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput added in v1.37.25 

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

func (TagResourceOutput) GoString added in v1.37.25 

func (s TagResourceOutput) GoString() string

GoString returns the string representation

func (TagResourceOutput) String added in v1.37.25 

func (s TagResourceOutput) String() string

String returns the string representation

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 `type:"timestamp"`

	// 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 `type:"timestamp"`
	// contains filtered or unexported fields
}

The time range.

func (TimeRange) GoString 

func (s TimeRange) GoString() string

GoString returns the string representation

func (*TimeRange) SetFromInclusive 

func (s *TimeRange) SetFromInclusive(v time.Time) *TimeRange

SetFromInclusive sets the FromInclusive field's value.

func (*TimeRange) SetToExclusive 

func (s *TimeRange) SetToExclusive(v time.Time) *TimeRange

SetToExclusive sets the ToExclusive field's value.

func (TimeRange) String 

func (s TimeRange) String() string

String returns the string representation

type UntagResourceInput added in v1.37.25 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource that you want to remove tags
	// from.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

	// The tag key for each tag that you want to remove from the resource.
	//
	// TagKeys is a required field
	TagKeys []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString added in v1.37.25 

func (s UntagResourceInput) GoString() string

GoString returns the string representation

func (*UntagResourceInput) SetResourceARN added in v1.37.25 

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

SetResourceARN sets the ResourceARN field's value.

func (*UntagResourceInput) SetTagKeys added in v1.37.25 

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

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.37.25 

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate added in v1.37.25 

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput added in v1.37.25 

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

func (UntagResourceOutput) GoString added in v1.37.25 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation

func (UntagResourceOutput) String added in v1.37.25 

func (s UntagResourceOutput) String() string

String returns the string representation

type UpdateEmergencyContactSettingsInput added in v1.14.1 

type UpdateEmergencyContactSettingsInput struct {

	// A list of email addresses and phone numbers that the DDoS Response Team (DRT)
	// can use to contact you if you have proactive engagement enabled, for escalations
	// to the DRT and to initiate proactive customer support.
	//
	// If you have proactive engagement enabled, the contact list must include at
	// least one phone number.
	EmergencyContactList []*EmergencyContact `type:"list"`
	// contains filtered or unexported fields
}

func (UpdateEmergencyContactSettingsInput) GoString added in v1.14.1 

func (s UpdateEmergencyContactSettingsInput) GoString() string

GoString returns the string representation

func (*UpdateEmergencyContactSettingsInput) SetEmergencyContactList added in v1.14.1 

func (s *UpdateEmergencyContactSettingsInput) SetEmergencyContactList(v []*EmergencyContact) *UpdateEmergencyContactSettingsInput

SetEmergencyContactList sets the EmergencyContactList field's value.

func (UpdateEmergencyContactSettingsInput) String added in v1.14.1 

func (s UpdateEmergencyContactSettingsInput) String() string

String returns the string representation

func (*UpdateEmergencyContactSettingsInput) Validate added in v1.14.1 

func (s *UpdateEmergencyContactSettingsInput) Validate() error

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

type UpdateEmergencyContactSettingsOutput added in v1.14.1 

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

func (UpdateEmergencyContactSettingsOutput) GoString added in v1.14.1 

func (s UpdateEmergencyContactSettingsOutput) GoString() string

GoString returns the string representation

func (UpdateEmergencyContactSettingsOutput) String added in v1.14.1 

func (s UpdateEmergencyContactSettingsOutput) String() string

String returns the string representation

type UpdateProtectionGroupInput added in v1.35.28 

type UpdateProtectionGroupInput struct {

	// Defines how AWS Shield combines resource data for the group in order to detect,
	// mitigate, and report events.
	//
	//    * Sum - Use the total traffic across the group. This is a good choice
	//    for most cases. Examples include Elastic IP addresses for EC2 instances
	//    that scale manually or automatically.
	//
	//    * Mean - Use the average of the traffic across the group. This is a good
	//    choice for resources that share traffic uniformly. Examples include accelerators
	//    and load balancers.
	//
	//    * Max - Use the highest traffic from each resource. This is useful for
	//    resources that don't share traffic and for resources that share that traffic
	//    in a non-uniform way. Examples include CloudFront distributions and origin
	//    resources for CloudFront distributions.
	//
	// Aggregation is a required field
	Aggregation *string `type:"string" required:"true" enum:"ProtectionGroupAggregation"`

	// The Amazon Resource Names (ARNs) of the resources to include in the protection
	// group. You must set this when you set Pattern to ARBITRARY and you must not
	// set it for any other Pattern setting.
	Members []*string `type:"list"`

	// The criteria to use to choose the protected resources for inclusion in the
	// group. You can include all resources that have protections, provide a list
	// of resource Amazon Resource Names (ARNs), or include all resources of a specified
	// resource type.
	//
	// Pattern is a required field
	Pattern *string `type:"string" required:"true" enum:"ProtectionGroupPattern"`

	// The name of the protection group. You use this to identify the protection
	// group in lists and to manage the protection group, for example to update,
	// delete, or describe it.
	//
	// ProtectionGroupId is a required field
	ProtectionGroupId *string `min:"1" type:"string" required:"true"`

	// The resource type to include in the protection group. All protected resources
	// of this type are included in the protection group. You must set this when
	// you set Pattern to BY_RESOURCE_TYPE and you must not set it for any other
	// Pattern setting.
	ResourceType *string `type:"string" enum:"ProtectedResourceType"`
	// contains filtered or unexported fields
}

func (UpdateProtectionGroupInput) GoString added in v1.35.28 

func (s UpdateProtectionGroupInput) GoString() string

GoString returns the string representation

func (*UpdateProtectionGroupInput) SetAggregation added in v1.35.28 

func (s *UpdateProtectionGroupInput) SetAggregation(v string) *UpdateProtectionGroupInput

SetAggregation sets the Aggregation field's value.

func (*UpdateProtectionGroupInput) SetMembers added in v1.35.28 

func (s *UpdateProtectionGroupInput) SetMembers(v []*string) *UpdateProtectionGroupInput

SetMembers sets the Members field's value.

func (*UpdateProtectionGroupInput) SetPattern added in v1.35.28 

func (s *UpdateProtectionGroupInput) SetPattern(v string) *UpdateProtectionGroupInput

SetPattern sets the Pattern field's value.

func (*UpdateProtectionGroupInput) SetProtectionGroupId added in v1.35.28 

func (s *UpdateProtectionGroupInput) SetProtectionGroupId(v string) *UpdateProtectionGroupInput

SetProtectionGroupId sets the ProtectionGroupId field's value.

func (*UpdateProtectionGroupInput) SetResourceType added in v1.35.28 

func (s *UpdateProtectionGroupInput) SetResourceType(v string) *UpdateProtectionGroupInput

SetResourceType sets the ResourceType field's value.

func (UpdateProtectionGroupInput) String added in v1.35.28 

func (s UpdateProtectionGroupInput) String() string

String returns the string representation

func (*UpdateProtectionGroupInput) Validate added in v1.35.28 

func (s *UpdateProtectionGroupInput) Validate() error

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

type UpdateProtectionGroupOutput added in v1.35.28 

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

func (UpdateProtectionGroupOutput) GoString added in v1.35.28 

func (s UpdateProtectionGroupOutput) GoString() string

GoString returns the string representation

func (UpdateProtectionGroupOutput) String added in v1.35.28 

func (s UpdateProtectionGroupOutput) String() string

String returns the string representation

type UpdateSubscriptionInput added in v1.14.1 

type UpdateSubscriptionInput struct {

	// When you initally create a subscription, AutoRenew is set to ENABLED. If
	// ENABLED, the subscription will be automatically renewed at the end of the
	// existing subscription period. 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 *string `type:"string" enum:"AutoRenew"`
	// contains filtered or unexported fields
}

func (UpdateSubscriptionInput) GoString added in v1.14.1 

func (s UpdateSubscriptionInput) GoString() string

GoString returns the string representation

func (*UpdateSubscriptionInput) SetAutoRenew added in v1.14.1 

func (s *UpdateSubscriptionInput) SetAutoRenew(v string) *UpdateSubscriptionInput

SetAutoRenew sets the AutoRenew field's value.

func (UpdateSubscriptionInput) String added in v1.14.1 

func (s UpdateSubscriptionInput) String() string

String returns the string representation

type UpdateSubscriptionOutput added in v1.14.1 

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

func (UpdateSubscriptionOutput) GoString added in v1.14.1 

func (s UpdateSubscriptionOutput) GoString() string

GoString returns the string representation

func (UpdateSubscriptionOutput) String added in v1.14.1 

func (s UpdateSubscriptionOutput) String() string

String returns the string representation

type ValidationExceptionField added in v1.35.28 

type ValidationExceptionField struct {

	// The message describing why the parameter failed validation.
	//
	// Message is a required field
	Message *string `locationName:"message" type:"string" required:"true"`

	// The name of the parameter that failed validation.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides information about a particular parameter passed inside a request that resulted in an exception.

func (ValidationExceptionField) GoString added in v1.35.28 

func (s ValidationExceptionField) GoString() string

GoString returns the string representation

func (*ValidationExceptionField) SetMessage added in v1.35.28 

func (s *ValidationExceptionField) SetMessage(v string) *ValidationExceptionField

SetMessage sets the Message field's value.

func (*ValidationExceptionField) SetName added in v1.35.28 

func (s *ValidationExceptionField) SetName(v string) *ValidationExceptionField

SetName sets the Name field's value.

func (ValidationExceptionField) String added in v1.35.28 

func (s ValidationExceptionField) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package shieldiface provides an interface to enable mocking the AWS Shield service client for testing your code.
 Package shieldiface provides an interface to enable mocking the AWS Shield service client for testing your code.

Jump to

Keyboard shortcuts

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