Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- 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
- 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
_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 :: AsError a => Getting (First ServiceError) a ServiceError Source #
Exception that indicates that the parameters passed to the API are invalid.
_LimitsExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Exception that indicates that the operation would exceed a limit.
_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 :: AsError a => Getting (First ServiceError) a ServiceError Source #
Exception indicating the specified resource already exists.
_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 :: AsError a => Getting (First ServiceError) a ServiceError Source #
Exception that indicates that the operation would not cause any change to occur.
_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 :: AsError a => Getting (First ServiceError) a ServiceError Source #
Exception indicating the specified resource does not exist.
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.