Copyright | (c) 2013-2017 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
AWS Shield Advanced
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 .
- shield :: Service
- _InvalidResourceException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitsExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalErrorException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _OptimisticLockException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidOperationException :: AsError a => Getting (First ServiceError) a ServiceError
- _LockedSubscriptionException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- module Network.AWS.Shield.CreateSubscription
- module Network.AWS.Shield.ListProtections
- module Network.AWS.Shield.DeleteSubscription
- module Network.AWS.Shield.DescribeAttack
- module Network.AWS.Shield.DescribeProtection
- module Network.AWS.Shield.ListAttacks
- module Network.AWS.Shield.CreateProtection
- module Network.AWS.Shield.DeleteProtection
- module Network.AWS.Shield.DescribeSubscription
- data SubResourceType
- data AttackDetail
- attackDetail :: AttackDetail
- adAttackId :: Lens' AttackDetail (Maybe Text)
- adStartTime :: Lens' AttackDetail (Maybe UTCTime)
- adSubResources :: Lens' AttackDetail [SubResourceSummary]
- adMitigations :: Lens' AttackDetail [Mitigation]
- adAttackCounters :: Lens' AttackDetail [SummarizedCounter]
- adResourceARN :: Lens' AttackDetail (Maybe Text)
- adEndTime :: Lens' AttackDetail (Maybe UTCTime)
- data AttackSummary
- attackSummary :: AttackSummary
- asAttackVectors :: Lens' AttackSummary [AttackVectorDescription]
- asAttackId :: Lens' AttackSummary (Maybe Text)
- asStartTime :: Lens' AttackSummary (Maybe UTCTime)
- asResourceARN :: Lens' AttackSummary (Maybe Text)
- asEndTime :: Lens' AttackSummary (Maybe UTCTime)
- data AttackVectorDescription
- attackVectorDescription :: Text -> AttackVectorDescription
- avdVectorType :: Lens' AttackVectorDescription Text
- data Mitigation
- mitigation :: Mitigation
- mMitigationName :: Lens' Mitigation (Maybe Text)
- data Protection
- protection :: Protection
- pResourceARN :: Lens' Protection (Maybe Text)
- pName :: Lens' Protection (Maybe Text)
- pId :: Lens' Protection (Maybe Text)
- data SubResourceSummary
- subResourceSummary :: SubResourceSummary
- srsCounters :: Lens' SubResourceSummary [SummarizedCounter]
- srsAttackVectors :: Lens' SubResourceSummary [SummarizedAttackVector]
- srsId :: Lens' SubResourceSummary (Maybe Text)
- srsType :: Lens' SubResourceSummary (Maybe SubResourceType)
- data Subscription
- subscription :: Subscription
- sTimeCommitmentInSeconds :: Lens' Subscription (Maybe Natural)
- sStartTime :: Lens' Subscription (Maybe UTCTime)
- data SummarizedAttackVector
- summarizedAttackVector :: Text -> SummarizedAttackVector
- savVectorCounters :: Lens' SummarizedAttackVector [SummarizedCounter]
- savVectorType :: Lens' SummarizedAttackVector Text
- data SummarizedCounter
- summarizedCounter :: SummarizedCounter
- scMax :: Lens' SummarizedCounter (Maybe Double)
- scAverage :: Lens' SummarizedCounter (Maybe Double)
- scN :: Lens' SummarizedCounter (Maybe Int)
- scName :: Lens' SummarizedCounter (Maybe Text)
- scSum :: Lens' SummarizedCounter (Maybe Double)
- scUnit :: Lens' SummarizedCounter (Maybe Text)
- data TimeRange
- timeRange :: TimeRange
- trFromInclusive :: Lens' TimeRange (Maybe UTCTime)
- trToExclusive :: Lens' TimeRange (Maybe UTCTime)
Service Configuration
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by Shield
.
InvalidResourceException
_InvalidResourceException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Exception that indicates that the resource is invalid. You might not have access to the resource, or the resource might not exist.
InvalidParameterException
_InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Exception that indicates that the parameters passed to the API are invalid.
LimitsExceededException
_LimitsExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Exception that indicates that the operation would exceed a limit.
InternalErrorException
_InternalErrorException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.
ResourceAlreadyExistsException
_ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Exception indicating the specified resource already exists.
OptimisticLockException
_OptimisticLockException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Exception that indicates that the protection state has been modified by another client. You can retry the request.
InvalidOperationException
_InvalidOperationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Exception that indicates that the operation would not cause any change to occur.
LockedSubscriptionException
_LockedSubscriptionException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Exception that indicates that the subscription has been modified by another client. You can retry the request.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Exception indicating the specified resource does not exist.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CreateSubscription
ListProtections
DeleteSubscription
DescribeAttack
DescribeProtection
ListAttacks
CreateProtection
DeleteProtection
DescribeSubscription
Types
SubResourceType
data SubResourceType Source #
AttackDetail
data AttackDetail Source #
The details of a DDoS attack.
See: attackDetail
smart constructor.
attackDetail :: AttackDetail Source #
Creates a value of AttackDetail
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
adAttackId
- The unique identifier (ID) of the attack.adStartTime
- The time the attack started, in the format 2016-12-16T13:50Z.adSubResources
- If applicable, additional detail about the resource being attacked, for example, IP address or URL.adMitigations
- List of mitigation actions taken for the attack.adAttackCounters
- List of counters that describe the attack for the specified time period.adResourceARN
- The ARN (Amazon Resource Name) of the resource that was attacked.adEndTime
- The time the attack ended, in the format 2016-12-16T13:50Z.
adAttackId :: Lens' AttackDetail (Maybe Text) Source #
The unique identifier (ID) of the attack.
adStartTime :: Lens' AttackDetail (Maybe UTCTime) Source #
The time the attack started, in the format 2016-12-16T13:50Z.
adSubResources :: Lens' AttackDetail [SubResourceSummary] Source #
If applicable, additional detail about the resource being attacked, for example, IP address or URL.
adMitigations :: Lens' AttackDetail [Mitigation] Source #
List of mitigation actions taken for the attack.
adAttackCounters :: Lens' AttackDetail [SummarizedCounter] Source #
List of counters that describe the attack for the specified time period.
adResourceARN :: Lens' AttackDetail (Maybe Text) Source #
The ARN (Amazon Resource Name) of the resource that was attacked.
adEndTime :: Lens' AttackDetail (Maybe UTCTime) Source #
The time the attack ended, in the format 2016-12-16T13:50Z.
AttackSummary
data AttackSummary Source #
Summarizes all DDoS attacks for a specified time period.
See: attackSummary
smart constructor.
attackSummary :: AttackSummary Source #
Creates a value of AttackSummary
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
asAttackVectors
- The list of attacks for a specified time period.asAttackId
- The unique identifier (ID) of the attack.asStartTime
- The start time of the attack, in the format 2016-12-16T13:50Z.asResourceARN
- The ARN (Amazon Resource Name) of the resource that was attacked.asEndTime
- The end time of the attack, in the format 2016-12-16T13:50Z.
asAttackVectors :: Lens' AttackSummary [AttackVectorDescription] Source #
The list of attacks for a specified time period.
asAttackId :: Lens' AttackSummary (Maybe Text) Source #
The unique identifier (ID) of the attack.
asStartTime :: Lens' AttackSummary (Maybe UTCTime) Source #
The start time of the attack, in the format 2016-12-16T13:50Z.
asResourceARN :: Lens' AttackSummary (Maybe Text) Source #
The ARN (Amazon Resource Name) of the resource that was attacked.
asEndTime :: Lens' AttackSummary (Maybe UTCTime) Source #
The end time of the attack, in the format 2016-12-16T13:50Z.
AttackVectorDescription
data AttackVectorDescription Source #
Describes the attack.
See: attackVectorDescription
smart constructor.
attackVectorDescription Source #
Creates a value of AttackVectorDescription
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
avdVectorType
- The attack type, for example, SNMP reflection or SYN flood.
avdVectorType :: Lens' AttackVectorDescription Text Source #
The attack type, for example, SNMP reflection or SYN flood.
Mitigation
data Mitigation Source #
The mitigation applied to a DDoS attack.
See: mitigation
smart constructor.
mitigation :: Mitigation Source #
Creates a value of Mitigation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mMitigationName
- The name of the mitigation taken for this attack.
mMitigationName :: Lens' Mitigation (Maybe Text) Source #
The name of the mitigation taken for this attack.
Protection
data Protection Source #
An object that represents a resource that is under DDoS protection.
See: protection
smart constructor.
protection :: Protection Source #
Creates a value of Protection
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pResourceARN
- The ARN (Amazon Resource Name) of the AWS resource that is protected.pName
- The friendly name of the protection. For example,My CloudFront distributions
.pId
- The unique identifier (ID) of the protection.
pResourceARN :: Lens' Protection (Maybe Text) Source #
The ARN (Amazon Resource Name) of the AWS resource that is protected.
pName :: Lens' Protection (Maybe Text) Source #
The friendly name of the protection. For example, My CloudFront distributions
.
SubResourceSummary
data SubResourceSummary Source #
The attack information for the specified SubResource.
See: subResourceSummary
smart constructor.
subResourceSummary :: SubResourceSummary Source #
Creates a value of SubResourceSummary
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
srsCounters
- The counters that describe the details of the attack.srsAttackVectors
- The list of attack types and associated counters.srsId
- The unique identifier (ID) of theSubResource
.srsType
- TheSubResource
type.
srsCounters :: Lens' SubResourceSummary [SummarizedCounter] Source #
The counters that describe the details of the attack.
srsAttackVectors :: Lens' SubResourceSummary [SummarizedAttackVector] Source #
The list of attack types and associated counters.
srsId :: Lens' SubResourceSummary (Maybe Text) Source #
The unique identifier (ID) of the SubResource
.
srsType :: Lens' SubResourceSummary (Maybe SubResourceType) Source #
The SubResource
type.
Subscription
data Subscription Source #
Information about the AWS Shield Advanced subscription for an account.
See: subscription
smart constructor.
subscription :: Subscription Source #
Creates a value of Subscription
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sTimeCommitmentInSeconds
- The length, in seconds, of the AWS Shield Advanced subscription for the account.sStartTime
- The start time of the subscription, in the format "2016-12-16T13:50Z".
sTimeCommitmentInSeconds :: Lens' Subscription (Maybe Natural) Source #
The length, in seconds, of the AWS Shield Advanced subscription for the account.
sStartTime :: Lens' Subscription (Maybe UTCTime) Source #
The start time of the subscription, in the format "2016-12-16T13:50Z".
SummarizedAttackVector
data SummarizedAttackVector Source #
A summary of information about the attack.
See: summarizedAttackVector
smart constructor.
summarizedAttackVector Source #
Creates a value of SummarizedAttackVector
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
savVectorCounters
- The list of counters that describe the details of the attack.savVectorType
- The attack type, for example, SNMP reflection or SYN flood.
savVectorCounters :: Lens' SummarizedAttackVector [SummarizedCounter] Source #
The list of counters that describe the details of the attack.
savVectorType :: Lens' SummarizedAttackVector Text Source #
The attack type, for example, SNMP reflection or SYN flood.
SummarizedCounter
data SummarizedCounter Source #
The counter that describes a DDoS attack.
See: summarizedCounter
smart constructor.
summarizedCounter :: SummarizedCounter Source #
Creates a value of SummarizedCounter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
scMax
- The maximum value of the counter for a specified time period.scAverage
- The average value of the counter for a specified time period.scN
- The number of counters for a specified time period.scName
- The counter name.scSum
- The total of counter values for a specified time period.scUnit
- The unit of the counters.
scMax :: Lens' SummarizedCounter (Maybe Double) Source #
The maximum value of the counter for a specified time period.
scAverage :: Lens' SummarizedCounter (Maybe Double) Source #
The average value of the counter for a specified time period.
scN :: Lens' SummarizedCounter (Maybe Int) Source #
The number of counters for a specified time period.
scSum :: Lens' SummarizedCounter (Maybe Double) Source #
The total of counter values for a specified time period.
TimeRange
The time range.
See: timeRange
smart constructor.
timeRange :: TimeRange Source #
Creates a value of TimeRange
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
trFromInclusive
- The start time, in the format 2016-12-16T13:50Z.trToExclusive
- The end time, in the format 2016-12-16T15:50Z.