Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Amazonka.Shield
Contents
- Service Configuration
- Errors
- AccessDeniedException
- AccessDeniedForDependencyException
- InternalErrorException
- InvalidOperationException
- InvalidPaginationTokenException
- InvalidParameterException
- InvalidResourceException
- LimitsExceededException
- LockedSubscriptionException
- NoAssociatedRoleException
- OptimisticLockException
- ResourceAlreadyExistsException
- ResourceNotFoundException
- Waiters
- Operations
- AssociateDRTLogBucket
- AssociateDRTRole
- AssociateHealthCheck
- AssociateProactiveEngagementDetails
- CreateProtection
- CreateProtectionGroup
- CreateSubscription
- DeleteProtection
- DeleteProtectionGroup
- DescribeAttack
- DescribeAttackStatistics
- DescribeDRTAccess
- DescribeEmergencyContactSettings
- DescribeProtection
- DescribeProtectionGroup
- DescribeSubscription
- DisableApplicationLayerAutomaticResponse
- DisableProactiveEngagement
- DisassociateDRTLogBucket
- DisassociateDRTRole
- DisassociateHealthCheck
- EnableApplicationLayerAutomaticResponse
- EnableProactiveEngagement
- GetSubscriptionState
- ListAttacks (Paginated)
- ListProtectionGroups
- ListProtections (Paginated)
- ListResourcesInProtectionGroup
- ListTagsForResource
- TagResource
- UntagResource
- UpdateApplicationLayerAutomaticResponse
- UpdateEmergencyContactSettings
- UpdateProtectionGroup
- UpdateSubscription
- Types
- ApplicationLayerAutomaticResponseStatus
- AttackLayer
- AttackPropertyIdentifier
- AutoRenew
- ProactiveEngagementStatus
- ProtectedResourceType
- ProtectionGroupAggregation
- ProtectionGroupPattern
- SubResourceType
- SubscriptionState
- Unit
- ApplicationLayerAutomaticResponseConfiguration
- AttackDetail
- AttackProperty
- AttackStatisticsDataItem
- AttackSummary
- AttackVectorDescription
- AttackVolume
- AttackVolumeStatistics
- BlockAction
- Contributor
- CountAction
- EmergencyContact
- InclusionProtectionFilters
- InclusionProtectionGroupFilters
- Limit
- Mitigation
- Protection
- ProtectionGroup
- ProtectionGroupArbitraryPatternLimits
- ProtectionGroupLimits
- ProtectionGroupPatternTypeLimits
- ProtectionLimits
- ResponseAction
- SubResourceSummary
- Subscription
- SubscriptionLimits
- SummarizedAttackVector
- SummarizedCounter
- Tag
- TimeRange
Description
Derived from API version 2016-06-02
of the AWS service descriptions, licensed under Apache 2.0.
Shield Advanced
This is the Shield Advanced API Reference. This guide is for developers who need detailed information about the Shield Advanced API actions, data types, and errors. For detailed information about WAF and Shield Advanced features and an overview of how to use the WAF and Shield Advanced APIs, see the WAF and Shield Developer Guide.
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _AccessDeniedForDependencyException :: AsError a => Fold a ServiceError
- _InternalErrorException :: AsError a => Fold a ServiceError
- _InvalidOperationException :: AsError a => Fold a ServiceError
- _InvalidPaginationTokenException :: AsError a => Fold a ServiceError
- _InvalidParameterException :: AsError a => Fold a ServiceError
- _InvalidResourceException :: AsError a => Fold a ServiceError
- _LimitsExceededException :: AsError a => Fold a ServiceError
- _LockedSubscriptionException :: AsError a => Fold a ServiceError
- _NoAssociatedRoleException :: AsError a => Fold a ServiceError
- _OptimisticLockException :: AsError a => Fold a ServiceError
- _ResourceAlreadyExistsException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- data AssociateDRTLogBucket = AssociateDRTLogBucket' Text
- newAssociateDRTLogBucket :: Text -> AssociateDRTLogBucket
- data AssociateDRTLogBucketResponse = AssociateDRTLogBucketResponse' Int
- newAssociateDRTLogBucketResponse :: Int -> AssociateDRTLogBucketResponse
- data AssociateDRTRole = AssociateDRTRole' Text
- newAssociateDRTRole :: Text -> AssociateDRTRole
- data AssociateDRTRoleResponse = AssociateDRTRoleResponse' Int
- newAssociateDRTRoleResponse :: Int -> AssociateDRTRoleResponse
- data AssociateHealthCheck = AssociateHealthCheck' Text Text
- newAssociateHealthCheck :: Text -> Text -> AssociateHealthCheck
- data AssociateHealthCheckResponse = AssociateHealthCheckResponse' Int
- newAssociateHealthCheckResponse :: Int -> AssociateHealthCheckResponse
- data AssociateProactiveEngagementDetails = AssociateProactiveEngagementDetails' [EmergencyContact]
- newAssociateProactiveEngagementDetails :: AssociateProactiveEngagementDetails
- data AssociateProactiveEngagementDetailsResponse = AssociateProactiveEngagementDetailsResponse' Int
- newAssociateProactiveEngagementDetailsResponse :: Int -> AssociateProactiveEngagementDetailsResponse
- data CreateProtection = CreateProtection' (Maybe [Tag]) Text Text
- newCreateProtection :: Text -> Text -> CreateProtection
- data CreateProtectionResponse = CreateProtectionResponse' (Maybe Text) Int
- newCreateProtectionResponse :: Int -> CreateProtectionResponse
- data CreateProtectionGroup = CreateProtectionGroup' (Maybe [Text]) (Maybe ProtectedResourceType) (Maybe [Tag]) Text ProtectionGroupAggregation ProtectionGroupPattern
- newCreateProtectionGroup :: Text -> ProtectionGroupAggregation -> ProtectionGroupPattern -> CreateProtectionGroup
- data CreateProtectionGroupResponse = CreateProtectionGroupResponse' Int
- newCreateProtectionGroupResponse :: Int -> CreateProtectionGroupResponse
- data CreateSubscription = CreateSubscription' {
- newCreateSubscription :: CreateSubscription
- data CreateSubscriptionResponse = CreateSubscriptionResponse' Int
- newCreateSubscriptionResponse :: Int -> CreateSubscriptionResponse
- data DeleteProtection = DeleteProtection' Text
- newDeleteProtection :: Text -> DeleteProtection
- data DeleteProtectionResponse = DeleteProtectionResponse' Int
- newDeleteProtectionResponse :: Int -> DeleteProtectionResponse
- data DeleteProtectionGroup = DeleteProtectionGroup' Text
- newDeleteProtectionGroup :: Text -> DeleteProtectionGroup
- data DeleteProtectionGroupResponse = DeleteProtectionGroupResponse' Int
- newDeleteProtectionGroupResponse :: Int -> DeleteProtectionGroupResponse
- data DescribeAttack = DescribeAttack' Text
- newDescribeAttack :: Text -> DescribeAttack
- data DescribeAttackResponse = DescribeAttackResponse' (Maybe AttackDetail) Int
- newDescribeAttackResponse :: Int -> DescribeAttackResponse
- data DescribeAttackStatistics = DescribeAttackStatistics' {
- newDescribeAttackStatistics :: DescribeAttackStatistics
- data DescribeAttackStatisticsResponse = DescribeAttackStatisticsResponse' Int TimeRange [AttackStatisticsDataItem]
- newDescribeAttackStatisticsResponse :: Int -> TimeRange -> DescribeAttackStatisticsResponse
- data DescribeDRTAccess = DescribeDRTAccess' {
- newDescribeDRTAccess :: DescribeDRTAccess
- data DescribeDRTAccessResponse = DescribeDRTAccessResponse' (Maybe [Text]) (Maybe Text) Int
- newDescribeDRTAccessResponse :: Int -> DescribeDRTAccessResponse
- data DescribeEmergencyContactSettings = DescribeEmergencyContactSettings' {
- newDescribeEmergencyContactSettings :: DescribeEmergencyContactSettings
- data DescribeEmergencyContactSettingsResponse = DescribeEmergencyContactSettingsResponse' (Maybe [EmergencyContact]) Int
- newDescribeEmergencyContactSettingsResponse :: Int -> DescribeEmergencyContactSettingsResponse
- data DescribeProtection = DescribeProtection' (Maybe Text) (Maybe Text)
- newDescribeProtection :: DescribeProtection
- data DescribeProtectionResponse = DescribeProtectionResponse' (Maybe Protection) Int
- newDescribeProtectionResponse :: Int -> DescribeProtectionResponse
- data DescribeProtectionGroup = DescribeProtectionGroup' Text
- newDescribeProtectionGroup :: Text -> DescribeProtectionGroup
- data DescribeProtectionGroupResponse = DescribeProtectionGroupResponse' Int ProtectionGroup
- newDescribeProtectionGroupResponse :: Int -> ProtectionGroup -> DescribeProtectionGroupResponse
- data DescribeSubscription = DescribeSubscription' {
- newDescribeSubscription :: DescribeSubscription
- data DescribeSubscriptionResponse = DescribeSubscriptionResponse' (Maybe Subscription) Int
- newDescribeSubscriptionResponse :: Int -> DescribeSubscriptionResponse
- data DisableApplicationLayerAutomaticResponse = DisableApplicationLayerAutomaticResponse' Text
- newDisableApplicationLayerAutomaticResponse :: Text -> DisableApplicationLayerAutomaticResponse
- data DisableApplicationLayerAutomaticResponseResponse = DisableApplicationLayerAutomaticResponseResponse' Int
- newDisableApplicationLayerAutomaticResponseResponse :: Int -> DisableApplicationLayerAutomaticResponseResponse
- data DisableProactiveEngagement = DisableProactiveEngagement' {
- newDisableProactiveEngagement :: DisableProactiveEngagement
- data DisableProactiveEngagementResponse = DisableProactiveEngagementResponse' Int
- newDisableProactiveEngagementResponse :: Int -> DisableProactiveEngagementResponse
- data DisassociateDRTLogBucket = DisassociateDRTLogBucket' Text
- newDisassociateDRTLogBucket :: Text -> DisassociateDRTLogBucket
- data DisassociateDRTLogBucketResponse = DisassociateDRTLogBucketResponse' Int
- newDisassociateDRTLogBucketResponse :: Int -> DisassociateDRTLogBucketResponse
- data DisassociateDRTRole = DisassociateDRTRole' {
- newDisassociateDRTRole :: DisassociateDRTRole
- data DisassociateDRTRoleResponse = DisassociateDRTRoleResponse' Int
- newDisassociateDRTRoleResponse :: Int -> DisassociateDRTRoleResponse
- data DisassociateHealthCheck = DisassociateHealthCheck' Text Text
- newDisassociateHealthCheck :: Text -> Text -> DisassociateHealthCheck
- data DisassociateHealthCheckResponse = DisassociateHealthCheckResponse' Int
- newDisassociateHealthCheckResponse :: Int -> DisassociateHealthCheckResponse
- data EnableApplicationLayerAutomaticResponse = EnableApplicationLayerAutomaticResponse' Text ResponseAction
- newEnableApplicationLayerAutomaticResponse :: Text -> ResponseAction -> EnableApplicationLayerAutomaticResponse
- data EnableApplicationLayerAutomaticResponseResponse = EnableApplicationLayerAutomaticResponseResponse' Int
- newEnableApplicationLayerAutomaticResponseResponse :: Int -> EnableApplicationLayerAutomaticResponseResponse
- data EnableProactiveEngagement = EnableProactiveEngagement' {
- newEnableProactiveEngagement :: EnableProactiveEngagement
- data EnableProactiveEngagementResponse = EnableProactiveEngagementResponse' Int
- newEnableProactiveEngagementResponse :: Int -> EnableProactiveEngagementResponse
- data GetSubscriptionState = GetSubscriptionState' {
- newGetSubscriptionState :: GetSubscriptionState
- data GetSubscriptionStateResponse = GetSubscriptionStateResponse' Int SubscriptionState
- newGetSubscriptionStateResponse :: Int -> SubscriptionState -> GetSubscriptionStateResponse
- data ListAttacks = ListAttacks' (Maybe TimeRange) (Maybe Natural) (Maybe Text) (Maybe [Text]) (Maybe TimeRange)
- newListAttacks :: ListAttacks
- data ListAttacksResponse = ListAttacksResponse' (Maybe [AttackSummary]) (Maybe Text) Int
- newListAttacksResponse :: Int -> ListAttacksResponse
- data ListProtectionGroups = ListProtectionGroups' (Maybe InclusionProtectionGroupFilters) (Maybe Natural) (Maybe Text)
- newListProtectionGroups :: ListProtectionGroups
- data ListProtectionGroupsResponse = ListProtectionGroupsResponse' (Maybe Text) Int [ProtectionGroup]
- newListProtectionGroupsResponse :: Int -> ListProtectionGroupsResponse
- data ListProtections = ListProtections' (Maybe InclusionProtectionFilters) (Maybe Natural) (Maybe Text)
- newListProtections :: ListProtections
- data ListProtectionsResponse = ListProtectionsResponse' (Maybe Text) (Maybe [Protection]) Int
- newListProtectionsResponse :: Int -> ListProtectionsResponse
- data ListResourcesInProtectionGroup = ListResourcesInProtectionGroup' (Maybe Natural) (Maybe Text) Text
- newListResourcesInProtectionGroup :: Text -> ListResourcesInProtectionGroup
- data ListResourcesInProtectionGroupResponse = ListResourcesInProtectionGroupResponse' (Maybe Text) Int [Text]
- newListResourcesInProtectionGroupResponse :: Int -> ListResourcesInProtectionGroupResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateApplicationLayerAutomaticResponse = UpdateApplicationLayerAutomaticResponse' Text ResponseAction
- newUpdateApplicationLayerAutomaticResponse :: Text -> ResponseAction -> UpdateApplicationLayerAutomaticResponse
- data UpdateApplicationLayerAutomaticResponseResponse = UpdateApplicationLayerAutomaticResponseResponse' Int
- newUpdateApplicationLayerAutomaticResponseResponse :: Int -> UpdateApplicationLayerAutomaticResponseResponse
- data UpdateEmergencyContactSettings = UpdateEmergencyContactSettings' (Maybe [EmergencyContact])
- newUpdateEmergencyContactSettings :: UpdateEmergencyContactSettings
- data UpdateEmergencyContactSettingsResponse = UpdateEmergencyContactSettingsResponse' Int
- newUpdateEmergencyContactSettingsResponse :: Int -> UpdateEmergencyContactSettingsResponse
- data UpdateProtectionGroup = UpdateProtectionGroup' (Maybe [Text]) (Maybe ProtectedResourceType) Text ProtectionGroupAggregation ProtectionGroupPattern
- newUpdateProtectionGroup :: Text -> ProtectionGroupAggregation -> ProtectionGroupPattern -> UpdateProtectionGroup
- data UpdateProtectionGroupResponse = UpdateProtectionGroupResponse' Int
- newUpdateProtectionGroupResponse :: Int -> UpdateProtectionGroupResponse
- data UpdateSubscription = UpdateSubscription' (Maybe AutoRenew)
- newUpdateSubscription :: UpdateSubscription
- data UpdateSubscriptionResponse = UpdateSubscriptionResponse' Int
- newUpdateSubscriptionResponse :: Int -> UpdateSubscriptionResponse
- newtype ApplicationLayerAutomaticResponseStatus where
- newtype AttackLayer where
- AttackLayer' { }
- pattern AttackLayer_APPLICATION :: AttackLayer
- pattern AttackLayer_NETWORK :: AttackLayer
- newtype AttackPropertyIdentifier where
- AttackPropertyIdentifier' { }
- pattern AttackPropertyIdentifier_DESTINATION_URL :: AttackPropertyIdentifier
- pattern AttackPropertyIdentifier_REFERRER :: AttackPropertyIdentifier
- pattern AttackPropertyIdentifier_SOURCE_ASN :: AttackPropertyIdentifier
- pattern AttackPropertyIdentifier_SOURCE_COUNTRY :: AttackPropertyIdentifier
- pattern AttackPropertyIdentifier_SOURCE_IP_ADDRESS :: AttackPropertyIdentifier
- pattern AttackPropertyIdentifier_SOURCE_USER_AGENT :: AttackPropertyIdentifier
- pattern AttackPropertyIdentifier_WORDPRESS_PINGBACK_REFLECTOR :: AttackPropertyIdentifier
- pattern AttackPropertyIdentifier_WORDPRESS_PINGBACK_SOURCE :: AttackPropertyIdentifier
- newtype AutoRenew where
- AutoRenew' { }
- pattern AutoRenew_DISABLED :: AutoRenew
- pattern AutoRenew_ENABLED :: AutoRenew
- newtype ProactiveEngagementStatus where
- newtype ProtectedResourceType where
- ProtectedResourceType' { }
- pattern ProtectedResourceType_APPLICATION_LOAD_BALANCER :: ProtectedResourceType
- pattern ProtectedResourceType_CLASSIC_LOAD_BALANCER :: ProtectedResourceType
- pattern ProtectedResourceType_CLOUDFRONT_DISTRIBUTION :: ProtectedResourceType
- pattern ProtectedResourceType_ELASTIC_IP_ALLOCATION :: ProtectedResourceType
- pattern ProtectedResourceType_GLOBAL_ACCELERATOR :: ProtectedResourceType
- pattern ProtectedResourceType_ROUTE_53_HOSTED_ZONE :: ProtectedResourceType
- newtype ProtectionGroupAggregation where
- newtype ProtectionGroupPattern where
- newtype SubResourceType where
- SubResourceType' { }
- pattern SubResourceType_IP :: SubResourceType
- pattern SubResourceType_URL :: SubResourceType
- newtype SubscriptionState where
- SubscriptionState' { }
- pattern SubscriptionState_ACTIVE :: SubscriptionState
- pattern SubscriptionState_INACTIVE :: SubscriptionState
- newtype Unit where
- Unit' { }
- pattern Unit_BITS :: Unit
- pattern Unit_BYTES :: Unit
- pattern Unit_PACKETS :: Unit
- pattern Unit_REQUESTS :: Unit
- data ApplicationLayerAutomaticResponseConfiguration = ApplicationLayerAutomaticResponseConfiguration' ApplicationLayerAutomaticResponseStatus ResponseAction
- newApplicationLayerAutomaticResponseConfiguration :: ApplicationLayerAutomaticResponseStatus -> ResponseAction -> ApplicationLayerAutomaticResponseConfiguration
- data AttackDetail = AttackDetail' (Maybe [SummarizedCounter]) (Maybe Text) (Maybe [AttackProperty]) (Maybe POSIX) (Maybe [Mitigation]) (Maybe Text) (Maybe POSIX) (Maybe [SubResourceSummary])
- newAttackDetail :: AttackDetail
- data AttackProperty = AttackProperty' (Maybe AttackLayer) (Maybe AttackPropertyIdentifier) (Maybe [Contributor]) (Maybe Integer) (Maybe Unit)
- newAttackProperty :: AttackProperty
- data AttackStatisticsDataItem = AttackStatisticsDataItem' (Maybe AttackVolume) Integer
- newAttackStatisticsDataItem :: Integer -> AttackStatisticsDataItem
- data AttackSummary = AttackSummary' (Maybe Text) (Maybe [AttackVectorDescription]) (Maybe POSIX) (Maybe Text) (Maybe POSIX)
- newAttackSummary :: AttackSummary
- data AttackVectorDescription = AttackVectorDescription' Text
- newAttackVectorDescription :: Text -> AttackVectorDescription
- data AttackVolume = AttackVolume' (Maybe AttackVolumeStatistics) (Maybe AttackVolumeStatistics) (Maybe AttackVolumeStatistics)
- newAttackVolume :: AttackVolume
- data AttackVolumeStatistics = AttackVolumeStatistics' Double
- newAttackVolumeStatistics :: Double -> AttackVolumeStatistics
- data BlockAction = BlockAction' {
- newBlockAction :: BlockAction
- data Contributor = Contributor' (Maybe Text) (Maybe Integer)
- newContributor :: Contributor
- data CountAction = CountAction' {
- newCountAction :: CountAction
- data EmergencyContact = EmergencyContact' (Maybe Text) (Maybe Text) Text
- newEmergencyContact :: Text -> EmergencyContact
- data InclusionProtectionFilters = InclusionProtectionFilters' (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty ProtectedResourceType))
- newInclusionProtectionFilters :: InclusionProtectionFilters
- data InclusionProtectionGroupFilters = InclusionProtectionGroupFilters' (Maybe (NonEmpty ProtectionGroupAggregation)) (Maybe (NonEmpty ProtectionGroupPattern)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty ProtectedResourceType))
- newInclusionProtectionGroupFilters :: InclusionProtectionGroupFilters
- data Limit = Limit' (Maybe Integer) (Maybe Text)
- newLimit :: Limit
- data Mitigation = Mitigation' (Maybe Text)
- newMitigation :: Mitigation
- data Protection = Protection' (Maybe ApplicationLayerAutomaticResponseConfiguration) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newProtection :: Protection
- data ProtectionGroup = ProtectionGroup' (Maybe Text) (Maybe ProtectedResourceType) Text ProtectionGroupAggregation ProtectionGroupPattern [Text]
- newProtectionGroup :: Text -> ProtectionGroupAggregation -> ProtectionGroupPattern -> ProtectionGroup
- data ProtectionGroupArbitraryPatternLimits = ProtectionGroupArbitraryPatternLimits' Integer
- newProtectionGroupArbitraryPatternLimits :: Integer -> ProtectionGroupArbitraryPatternLimits
- data ProtectionGroupLimits = ProtectionGroupLimits' Integer ProtectionGroupPatternTypeLimits
- newProtectionGroupLimits :: Integer -> ProtectionGroupPatternTypeLimits -> ProtectionGroupLimits
- data ProtectionGroupPatternTypeLimits = ProtectionGroupPatternTypeLimits' ProtectionGroupArbitraryPatternLimits
- newProtectionGroupPatternTypeLimits :: ProtectionGroupArbitraryPatternLimits -> ProtectionGroupPatternTypeLimits
- data ProtectionLimits = ProtectionLimits' [Limit]
- newProtectionLimits :: ProtectionLimits
- data ResponseAction = ResponseAction' (Maybe BlockAction) (Maybe CountAction)
- newResponseAction :: ResponseAction
- data SubResourceSummary = SubResourceSummary' (Maybe [SummarizedAttackVector]) (Maybe [SummarizedCounter]) (Maybe Text) (Maybe SubResourceType)
- newSubResourceSummary :: SubResourceSummary
- data Subscription = Subscription' (Maybe AutoRenew) (Maybe POSIX) (Maybe [Limit]) (Maybe ProactiveEngagementStatus) (Maybe POSIX) (Maybe Text) (Maybe Natural) SubscriptionLimits
- newSubscription :: SubscriptionLimits -> Subscription
- data SubscriptionLimits = SubscriptionLimits' ProtectionLimits ProtectionGroupLimits
- newSubscriptionLimits :: ProtectionLimits -> ProtectionGroupLimits -> SubscriptionLimits
- data SummarizedAttackVector = SummarizedAttackVector' (Maybe [SummarizedCounter]) Text
- newSummarizedAttackVector :: Text -> SummarizedAttackVector
- data SummarizedCounter = SummarizedCounter' (Maybe Double) (Maybe Double) (Maybe Int) (Maybe Text) (Maybe Double) (Maybe Text)
- newSummarizedCounter :: SummarizedCounter
- data Tag = Tag' (Maybe Text) (Maybe Text)
- newTag :: Tag
- data TimeRange = TimeRange' (Maybe POSIX) (Maybe POSIX)
- newTimeRange :: TimeRange
Service Configuration
defaultService :: Service Source #
API version 2016-06-02
of the Amazon Shield SDK 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
.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
Exception that indicates the specified AttackId
does not exist, or the
requester does not have the appropriate permissions to access the
AttackId
.
AccessDeniedForDependencyException
_AccessDeniedForDependencyException :: AsError a => Fold a ServiceError Source #
In order to grant the necessary access to the Shield Response Team (SRT)
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 Amazon Web Services Service.
InternalErrorException
_InternalErrorException :: AsError a => Fold a ServiceError Source #
Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.
InvalidOperationException
_InvalidOperationException :: AsError a => Fold a ServiceError Source #
Exception that indicates that the operation would not cause any change to occur.
InvalidPaginationTokenException
_InvalidPaginationTokenException :: AsError a => Fold a ServiceError Source #
Exception that indicates that the NextToken
specified in the request
is invalid. Submit the request using the NextToken
value that was
returned in the prior response.
InvalidParameterException
_InvalidParameterException :: AsError a => Fold a ServiceError Source #
Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.
InvalidResourceException
_InvalidResourceException :: AsError a => Fold 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.
LimitsExceededException
_LimitsExceededException :: AsError a => Fold a ServiceError Source #
Exception that indicates that the operation would exceed a limit.
LockedSubscriptionException
_LockedSubscriptionException :: AsError a => Fold a ServiceError Source #
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.
NoAssociatedRoleException
_NoAssociatedRoleException :: AsError a => Fold a ServiceError Source #
The ARN of the role that you specified does not exist.
OptimisticLockException
_OptimisticLockException :: AsError a => Fold a ServiceError Source #
Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.
ResourceAlreadyExistsException
_ResourceAlreadyExistsException :: AsError a => Fold a ServiceError Source #
Exception indicating the specified resource already exists. If available, this exception includes details in additional properties.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
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.
AssociateDRTLogBucket
data AssociateDRTLogBucket Source #
See: newAssociateDRTLogBucket
smart constructor.
Constructors
AssociateDRTLogBucket' Text |
Instances
newAssociateDRTLogBucket Source #
Create a value of AssociateDRTLogBucket
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:logBucket:AssociateDRTLogBucket'
, associateDRTLogBucket_logBucket
- The Amazon S3 bucket that contains the logs that you want to share.
data AssociateDRTLogBucketResponse Source #
See: newAssociateDRTLogBucketResponse
smart constructor.
Constructors
AssociateDRTLogBucketResponse' Int |
Instances
newAssociateDRTLogBucketResponse Source #
Create a value of AssociateDRTLogBucketResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:AssociateDRTLogBucketResponse'
, associateDRTLogBucketResponse_httpStatus
- The response's http status code.
AssociateDRTRole
data AssociateDRTRole Source #
See: newAssociateDRTRole
smart constructor.
Constructors
AssociateDRTRole' Text |
Instances
Arguments
:: Text | |
-> AssociateDRTRole |
Create a value of AssociateDRTRole
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:roleArn:AssociateDRTRole'
, associateDRTRole_roleArn
- The Amazon Resource Name (ARN) of the role the SRT will use to access
your Amazon Web Services account.
Prior to making the AssociateDRTRole
request, you must attach the
AWSShieldDRTAccessPolicy
managed policy to this role. For more information see
Attaching and Detaching IAM Policies.
data AssociateDRTRoleResponse Source #
See: newAssociateDRTRoleResponse
smart constructor.
Constructors
AssociateDRTRoleResponse' Int |
Instances
newAssociateDRTRoleResponse Source #
Create a value of AssociateDRTRoleResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:AssociateDRTRoleResponse'
, associateDRTRoleResponse_httpStatus
- The response's http status code.
AssociateHealthCheck
data AssociateHealthCheck Source #
See: newAssociateHealthCheck
smart constructor.
Constructors
AssociateHealthCheck' Text Text |
Instances
newAssociateHealthCheck Source #
Arguments
:: Text | |
-> Text | |
-> AssociateHealthCheck |
Create a value of AssociateHealthCheck
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:protectionId:AssociateHealthCheck'
, associateHealthCheck_protectionId
- The unique identifier (ID) for the Protection object to add the health
check association to.
$sel:healthCheckArn:AssociateHealthCheck'
, associateHealthCheck_healthCheckArn
- The Amazon Resource Name (ARN) of the health check to associate with the
protection.
data AssociateHealthCheckResponse Source #
See: newAssociateHealthCheckResponse
smart constructor.
Constructors
AssociateHealthCheckResponse' Int |
Instances
newAssociateHealthCheckResponse Source #
Create a value of AssociateHealthCheckResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:AssociateHealthCheckResponse'
, associateHealthCheckResponse_httpStatus
- The response's http status code.
AssociateProactiveEngagementDetails
data AssociateProactiveEngagementDetails Source #
See: newAssociateProactiveEngagementDetails
smart constructor.
Constructors
AssociateProactiveEngagementDetails' [EmergencyContact] |
Instances
newAssociateProactiveEngagementDetails :: AssociateProactiveEngagementDetails Source #
Create a value of AssociateProactiveEngagementDetails
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:emergencyContactList:AssociateProactiveEngagementDetails'
, associateProactiveEngagementDetails_emergencyContactList
- A list of email addresses and phone numbers that the Shield Response
Team (SRT) can use to contact you for escalations to the SRT 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.
data AssociateProactiveEngagementDetailsResponse Source #
See: newAssociateProactiveEngagementDetailsResponse
smart constructor.
Constructors
AssociateProactiveEngagementDetailsResponse' Int |
Instances
newAssociateProactiveEngagementDetailsResponse Source #
Arguments
:: Int |
|
-> AssociateProactiveEngagementDetailsResponse |
Create a value of AssociateProactiveEngagementDetailsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:AssociateProactiveEngagementDetailsResponse'
, associateProactiveEngagementDetailsResponse_httpStatus
- The response's http status code.
CreateProtection
data CreateProtection Source #
See: newCreateProtection
smart constructor.
Constructors
CreateProtection' (Maybe [Tag]) Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> CreateProtection |
Create a value of CreateProtection
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:CreateProtection'
, createProtection_tags
- One or more tag key-value pairs for the Protection object that is
created.
CreateProtection
, createProtection_name
- Friendly name for the Protection
you are creating.
CreateProtection
, createProtection_resourceArn
- 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 Amazon CloudFront distribution:
arn:aws:cloudfront::
account-id
:distribution/
distribution-id
- For an Global Accelerator standard 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
data CreateProtectionResponse Source #
See: newCreateProtectionResponse
smart constructor.
Constructors
CreateProtectionResponse' (Maybe Text) Int |
Instances
newCreateProtectionResponse Source #
Create a value of CreateProtectionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:protectionId:CreateProtectionResponse'
, createProtectionResponse_protectionId
- The unique identifier (ID) for the Protection object that is created.
$sel:httpStatus:CreateProtectionResponse'
, createProtectionResponse_httpStatus
- The response's http status code.
CreateProtectionGroup
data CreateProtectionGroup Source #
See: newCreateProtectionGroup
smart constructor.
Constructors
CreateProtectionGroup' (Maybe [Text]) (Maybe ProtectedResourceType) (Maybe [Tag]) Text ProtectionGroupAggregation ProtectionGroupPattern |
Instances
newCreateProtectionGroup Source #
Arguments
:: Text | |
-> ProtectionGroupAggregation | |
-> ProtectionGroupPattern | |
-> CreateProtectionGroup |
Create a value of CreateProtectionGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateProtectionGroup
, createProtectionGroup_members
- 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.
CreateProtectionGroup
, createProtectionGroup_resourceType
- 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.
$sel:tags:CreateProtectionGroup'
, createProtectionGroup_tags
- One or more tag key-value pairs for the protection group.
CreateProtectionGroup
, createProtectionGroup_protectionGroupId
- 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.
CreateProtectionGroup
, createProtectionGroup_aggregation
- Defines how 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 Amazon CloudFront and origin resources for CloudFront distributions.
CreateProtectionGroup
, createProtectionGroup_pattern
- 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.
data CreateProtectionGroupResponse Source #
See: newCreateProtectionGroupResponse
smart constructor.
Constructors
CreateProtectionGroupResponse' Int |
Instances
newCreateProtectionGroupResponse Source #
Create a value of CreateProtectionGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateProtectionGroupResponse'
, createProtectionGroupResponse_httpStatus
- The response's http status code.
CreateSubscription
data CreateSubscription Source #
See: newCreateSubscription
smart constructor.
Constructors
CreateSubscription' | |
Instances
newCreateSubscription :: CreateSubscription Source #
Create a value of CreateSubscription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data CreateSubscriptionResponse Source #
See: newCreateSubscriptionResponse
smart constructor.
Constructors
CreateSubscriptionResponse' Int |
Instances
newCreateSubscriptionResponse Source #
Create a value of CreateSubscriptionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateSubscriptionResponse'
, createSubscriptionResponse_httpStatus
- The response's http status code.
DeleteProtection
data DeleteProtection Source #
See: newDeleteProtection
smart constructor.
Constructors
DeleteProtection' Text |
Instances
Arguments
:: Text | |
-> DeleteProtection |
Create a value of DeleteProtection
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:protectionId:DeleteProtection'
, deleteProtection_protectionId
- The unique identifier (ID) for the Protection object to be deleted.
data DeleteProtectionResponse Source #
See: newDeleteProtectionResponse
smart constructor.
Constructors
DeleteProtectionResponse' Int |
Instances
newDeleteProtectionResponse Source #
Create a value of DeleteProtectionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteProtectionResponse'
, deleteProtectionResponse_httpStatus
- The response's http status code.
DeleteProtectionGroup
data DeleteProtectionGroup Source #
See: newDeleteProtectionGroup
smart constructor.
Constructors
DeleteProtectionGroup' Text |
Instances
newDeleteProtectionGroup Source #
Arguments
:: Text | |
-> DeleteProtectionGroup |
Create a value of DeleteProtectionGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteProtectionGroup
, deleteProtectionGroup_protectionGroupId
- 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.
data DeleteProtectionGroupResponse Source #
See: newDeleteProtectionGroupResponse
smart constructor.
Constructors
DeleteProtectionGroupResponse' Int |
Instances
newDeleteProtectionGroupResponse Source #
Create a value of DeleteProtectionGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteProtectionGroupResponse'
, deleteProtectionGroupResponse_httpStatus
- The response's http status code.
DescribeAttack
data DescribeAttack Source #
See: newDescribeAttack
smart constructor.
Constructors
DescribeAttack' Text |
Instances
Arguments
:: Text | |
-> DescribeAttack |
Create a value of DescribeAttack
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeAttack
, describeAttack_attackId
- The unique identifier (ID) for the attack.
data DescribeAttackResponse Source #
See: newDescribeAttackResponse
smart constructor.
Constructors
DescribeAttackResponse' (Maybe AttackDetail) Int |
Instances
newDescribeAttackResponse Source #
Create a value of DescribeAttackResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attack:DescribeAttackResponse'
, describeAttackResponse_attack
- The attack that you requested.
$sel:httpStatus:DescribeAttackResponse'
, describeAttackResponse_httpStatus
- The response's http status code.
DescribeAttackStatistics
data DescribeAttackStatistics Source #
See: newDescribeAttackStatistics
smart constructor.
Constructors
DescribeAttackStatistics' | |
Instances
newDescribeAttackStatistics :: DescribeAttackStatistics Source #
Create a value of DescribeAttackStatistics
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data DescribeAttackStatisticsResponse Source #
See: newDescribeAttackStatisticsResponse
smart constructor.
Instances
newDescribeAttackStatisticsResponse Source #
Arguments
:: Int | |
-> TimeRange | |
-> DescribeAttackStatisticsResponse |
Create a value of DescribeAttackStatisticsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeAttackStatisticsResponse'
, describeAttackStatisticsResponse_httpStatus
- The response's http status code.
$sel:timeRange:DescribeAttackStatisticsResponse'
, describeAttackStatisticsResponse_timeRange
- The time range of the attack.
$sel:dataItems:DescribeAttackStatisticsResponse'
, describeAttackStatisticsResponse_dataItems
- The data that describes the attacks detected during the time period.
DescribeDRTAccess
data DescribeDRTAccess Source #
See: newDescribeDRTAccess
smart constructor.
Constructors
DescribeDRTAccess' | |
Instances
newDescribeDRTAccess :: DescribeDRTAccess Source #
Create a value of DescribeDRTAccess
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data DescribeDRTAccessResponse Source #
See: newDescribeDRTAccessResponse
smart constructor.
Instances
newDescribeDRTAccessResponse Source #
Create a value of DescribeDRTAccessResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:logBucketList:DescribeDRTAccessResponse'
, describeDRTAccessResponse_logBucketList
- The list of Amazon S3 buckets accessed by the SRT.
$sel:roleArn:DescribeDRTAccessResponse'
, describeDRTAccessResponse_roleArn
- The Amazon Resource Name (ARN) of the role the SRT used to access your
Amazon Web Services account.
$sel:httpStatus:DescribeDRTAccessResponse'
, describeDRTAccessResponse_httpStatus
- The response's http status code.
DescribeEmergencyContactSettings
data DescribeEmergencyContactSettings Source #
See: newDescribeEmergencyContactSettings
smart constructor.
Constructors
DescribeEmergencyContactSettings' | |
Instances
newDescribeEmergencyContactSettings :: DescribeEmergencyContactSettings Source #
Create a value of DescribeEmergencyContactSettings
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data DescribeEmergencyContactSettingsResponse Source #
See: newDescribeEmergencyContactSettingsResponse
smart constructor.
Constructors
DescribeEmergencyContactSettingsResponse' (Maybe [EmergencyContact]) Int |
Instances
newDescribeEmergencyContactSettingsResponse Source #
Arguments
:: Int | |
-> DescribeEmergencyContactSettingsResponse |
Create a value of DescribeEmergencyContactSettingsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:emergencyContactList:DescribeEmergencyContactSettingsResponse'
, describeEmergencyContactSettingsResponse_emergencyContactList
- A list of email addresses and phone numbers that the Shield Response
Team (SRT) can use to contact you if you have proactive engagement
enabled, for escalations to the SRT and to initiate proactive customer
support.
$sel:httpStatus:DescribeEmergencyContactSettingsResponse'
, describeEmergencyContactSettingsResponse_httpStatus
- The response's http status code.
DescribeProtection
data DescribeProtection Source #
See: newDescribeProtection
smart constructor.
Constructors
DescribeProtection' (Maybe Text) (Maybe Text) |
Instances
newDescribeProtection :: DescribeProtection Source #
Create a value of DescribeProtection
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:protectionId:DescribeProtection'
, describeProtection_protectionId
- The unique identifier (ID) for the Protection object to describe. You
must provide either the ResourceArn
of the protected resource or the
ProtectionID
of the protection, but not both.
DescribeProtection
, describeProtection_resourceArn
- The ARN (Amazon Resource Name) of the protected Amazon Web Services
resource. You must provide either the ResourceArn
of the protected
resource or the ProtectionID
of the protection, but not both.
data DescribeProtectionResponse Source #
See: newDescribeProtectionResponse
smart constructor.
Constructors
DescribeProtectionResponse' (Maybe Protection) Int |
Instances
newDescribeProtectionResponse Source #
Create a value of DescribeProtectionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:protection:DescribeProtectionResponse'
, describeProtectionResponse_protection
- The Protection that you requested.
$sel:httpStatus:DescribeProtectionResponse'
, describeProtectionResponse_httpStatus
- The response's http status code.
DescribeProtectionGroup
data DescribeProtectionGroup Source #
See: newDescribeProtectionGroup
smart constructor.
Constructors
DescribeProtectionGroup' Text |
Instances
newDescribeProtectionGroup Source #
Arguments
:: Text | |
-> DescribeProtectionGroup |
Create a value of DescribeProtectionGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeProtectionGroup
, describeProtectionGroup_protectionGroupId
- 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.
data DescribeProtectionGroupResponse Source #
See: newDescribeProtectionGroupResponse
smart constructor.
Constructors
DescribeProtectionGroupResponse' Int ProtectionGroup |
Instances
newDescribeProtectionGroupResponse Source #
Arguments
:: Int | |
-> ProtectionGroup | |
-> DescribeProtectionGroupResponse |
Create a value of DescribeProtectionGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeProtectionGroupResponse'
, describeProtectionGroupResponse_httpStatus
- The response's http status code.
$sel:protectionGroup:DescribeProtectionGroupResponse'
, describeProtectionGroupResponse_protectionGroup
- A grouping of protected resources that you and Shield Advanced can
monitor as a collective. This resource grouping improves the accuracy of
detection and reduces false positives.
DescribeSubscription
data DescribeSubscription Source #
See: newDescribeSubscription
smart constructor.
Constructors
DescribeSubscription' | |
Instances
newDescribeSubscription :: DescribeSubscription Source #
Create a value of DescribeSubscription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data DescribeSubscriptionResponse Source #
See: newDescribeSubscriptionResponse
smart constructor.
Constructors
DescribeSubscriptionResponse' (Maybe Subscription) Int |
Instances
newDescribeSubscriptionResponse Source #
Create a value of DescribeSubscriptionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:subscription:DescribeSubscriptionResponse'
, describeSubscriptionResponse_subscription
- The Shield Advanced subscription details for an account.
$sel:httpStatus:DescribeSubscriptionResponse'
, describeSubscriptionResponse_httpStatus
- The response's http status code.
DisableApplicationLayerAutomaticResponse
data DisableApplicationLayerAutomaticResponse Source #
See: newDisableApplicationLayerAutomaticResponse
smart constructor.
Constructors
DisableApplicationLayerAutomaticResponse' Text |
Instances
newDisableApplicationLayerAutomaticResponse Source #
Create a value of DisableApplicationLayerAutomaticResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DisableApplicationLayerAutomaticResponse
, disableApplicationLayerAutomaticResponse_resourceArn
- The ARN (Amazon Resource Name) of the protected resource.
data DisableApplicationLayerAutomaticResponseResponse Source #
See: newDisableApplicationLayerAutomaticResponseResponse
smart constructor.
Constructors
DisableApplicationLayerAutomaticResponseResponse' Int |
Instances
newDisableApplicationLayerAutomaticResponseResponse Source #
Arguments
:: Int |
|
-> DisableApplicationLayerAutomaticResponseResponse |
Create a value of DisableApplicationLayerAutomaticResponseResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DisableApplicationLayerAutomaticResponseResponse'
, disableApplicationLayerAutomaticResponseResponse_httpStatus
- The response's http status code.
DisableProactiveEngagement
data DisableProactiveEngagement Source #
See: newDisableProactiveEngagement
smart constructor.
Constructors
DisableProactiveEngagement' | |
Instances
newDisableProactiveEngagement :: DisableProactiveEngagement Source #
Create a value of DisableProactiveEngagement
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data DisableProactiveEngagementResponse Source #
See: newDisableProactiveEngagementResponse
smart constructor.
Constructors
DisableProactiveEngagementResponse' Int |
Instances
newDisableProactiveEngagementResponse Source #
Arguments
:: Int | |
-> DisableProactiveEngagementResponse |
Create a value of DisableProactiveEngagementResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DisableProactiveEngagementResponse'
, disableProactiveEngagementResponse_httpStatus
- The response's http status code.
DisassociateDRTLogBucket
data DisassociateDRTLogBucket Source #
See: newDisassociateDRTLogBucket
smart constructor.
Constructors
DisassociateDRTLogBucket' Text |
Instances
newDisassociateDRTLogBucket Source #
Create a value of DisassociateDRTLogBucket
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:logBucket:DisassociateDRTLogBucket'
, disassociateDRTLogBucket_logBucket
- The Amazon S3 bucket that contains the logs that you want to share.
data DisassociateDRTLogBucketResponse Source #
See: newDisassociateDRTLogBucketResponse
smart constructor.
Constructors
DisassociateDRTLogBucketResponse' Int |
Instances
newDisassociateDRTLogBucketResponse Source #
Create a value of DisassociateDRTLogBucketResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DisassociateDRTLogBucketResponse'
, disassociateDRTLogBucketResponse_httpStatus
- The response's http status code.
DisassociateDRTRole
data DisassociateDRTRole Source #
See: newDisassociateDRTRole
smart constructor.
Constructors
DisassociateDRTRole' | |
Instances
newDisassociateDRTRole :: DisassociateDRTRole Source #
Create a value of DisassociateDRTRole
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data DisassociateDRTRoleResponse Source #
See: newDisassociateDRTRoleResponse
smart constructor.
Constructors
DisassociateDRTRoleResponse' Int |
Instances
newDisassociateDRTRoleResponse Source #
Create a value of DisassociateDRTRoleResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DisassociateDRTRoleResponse'
, disassociateDRTRoleResponse_httpStatus
- The response's http status code.
DisassociateHealthCheck
data DisassociateHealthCheck Source #
See: newDisassociateHealthCheck
smart constructor.
Constructors
DisassociateHealthCheck' Text Text |
Instances
newDisassociateHealthCheck Source #
Arguments
:: Text | |
-> Text | |
-> DisassociateHealthCheck |
Create a value of DisassociateHealthCheck
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:protectionId:DisassociateHealthCheck'
, disassociateHealthCheck_protectionId
- The unique identifier (ID) for the Protection object to remove the
health check association from.
$sel:healthCheckArn:DisassociateHealthCheck'
, disassociateHealthCheck_healthCheckArn
- The Amazon Resource Name (ARN) of the health check that is associated
with the protection.
data DisassociateHealthCheckResponse Source #
See: newDisassociateHealthCheckResponse
smart constructor.
Constructors
DisassociateHealthCheckResponse' Int |
Instances
newDisassociateHealthCheckResponse Source #
Create a value of DisassociateHealthCheckResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DisassociateHealthCheckResponse'
, disassociateHealthCheckResponse_httpStatus
- The response's http status code.
EnableApplicationLayerAutomaticResponse
data EnableApplicationLayerAutomaticResponse Source #
See: newEnableApplicationLayerAutomaticResponse
smart constructor.
Instances
newEnableApplicationLayerAutomaticResponse Source #
Arguments
:: Text | |
-> ResponseAction | |
-> EnableApplicationLayerAutomaticResponse |
Create a value of EnableApplicationLayerAutomaticResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
EnableApplicationLayerAutomaticResponse
, enableApplicationLayerAutomaticResponse_resourceArn
- The ARN (Amazon Resource Name) of the protected resource.
EnableApplicationLayerAutomaticResponse
, enableApplicationLayerAutomaticResponse_action
- Specifies the action setting that Shield Advanced should use in the WAF
rules that it creates on behalf of the protected resource in response to
DDoS attacks. You specify this as part of the configuration for the
automatic application layer DDoS mitigation feature, when you enable or
update automatic mitigation. Shield Advanced creates the WAF rules in a
Shield Advanced-managed rule group, inside the web ACL that you have
associated with the resource.
data EnableApplicationLayerAutomaticResponseResponse Source #
See: newEnableApplicationLayerAutomaticResponseResponse
smart constructor.
Constructors
EnableApplicationLayerAutomaticResponseResponse' Int |
Instances
newEnableApplicationLayerAutomaticResponseResponse Source #
Arguments
:: Int |
|
-> EnableApplicationLayerAutomaticResponseResponse |
Create a value of EnableApplicationLayerAutomaticResponseResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:EnableApplicationLayerAutomaticResponseResponse'
, enableApplicationLayerAutomaticResponseResponse_httpStatus
- The response's http status code.
EnableProactiveEngagement
data EnableProactiveEngagement Source #
See: newEnableProactiveEngagement
smart constructor.
Constructors
EnableProactiveEngagement' | |
Instances
newEnableProactiveEngagement :: EnableProactiveEngagement Source #
Create a value of EnableProactiveEngagement
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data EnableProactiveEngagementResponse Source #
See: newEnableProactiveEngagementResponse
smart constructor.
Constructors
EnableProactiveEngagementResponse' Int |
Instances
newEnableProactiveEngagementResponse Source #
Arguments
:: Int | |
-> EnableProactiveEngagementResponse |
Create a value of EnableProactiveEngagementResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:EnableProactiveEngagementResponse'
, enableProactiveEngagementResponse_httpStatus
- The response's http status code.
GetSubscriptionState
data GetSubscriptionState Source #
See: newGetSubscriptionState
smart constructor.
Constructors
GetSubscriptionState' | |
Instances
newGetSubscriptionState :: GetSubscriptionState Source #
Create a value of GetSubscriptionState
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data GetSubscriptionStateResponse Source #
See: newGetSubscriptionStateResponse
smart constructor.
Constructors
GetSubscriptionStateResponse' Int SubscriptionState |
Instances
newGetSubscriptionStateResponse Source #
Arguments
:: Int | |
-> SubscriptionState | |
-> GetSubscriptionStateResponse |
Create a value of GetSubscriptionStateResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:GetSubscriptionStateResponse'
, getSubscriptionStateResponse_httpStatus
- The response's http status code.
$sel:subscriptionState:GetSubscriptionStateResponse'
, getSubscriptionStateResponse_subscriptionState
- The status of the subscription.
ListAttacks (Paginated)
data ListAttacks Source #
See: newListAttacks
smart constructor.
Constructors
ListAttacks' (Maybe TimeRange) (Maybe Natural) (Maybe Text) (Maybe [Text]) (Maybe TimeRange) |
Instances
newListAttacks :: ListAttacks Source #
Create a value of ListAttacks
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListAttacks
, listAttacks_endTime
- The end of the time period for the attacks. This is a timestamp
type.
The request syntax listing for this call indicates a number
type, but
you can provide the time in any valid
timestamp format
setting.
$sel:maxResults:ListAttacks'
, listAttacks_maxResults
- The greatest number of objects that you want Shield Advanced to return
to the list request. Shield Advanced might return fewer objects than you
indicate in this setting, even if more objects are available. If there
are more objects remaining, Shield Advanced will always also return a
NextToken
value in the response.
The default setting is 20.
ListAttacks
, listAttacks_nextToken
- When you request a list of objects from Shield Advanced, if the response
does not include all of the remaining available objects, Shield Advanced
includes a NextToken
value in the response. You can retrieve the next
batch of objects by requesting the list again and providing the token
that was returned by the prior call in your request.
You can indicate the maximum number of objects that you want Shield
Advanced to return for a single call with the MaxResults
setting.
Shield Advanced will not return more than MaxResults
objects, but may
return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned
to you, the response will include a NextToken
value.
On your first call to a list operation, leave this setting empty.
ListAttacks
, listAttacks_resourceArns
- The ARNs (Amazon Resource Names) of the resources that were attacked. If
you leave this blank, all applicable resources for this account will be
included.
ListAttacks
, listAttacks_startTime
- The start of the time period for the attacks. This is a timestamp
type. The request syntax listing for this call indicates a number
type, but you can provide the time in any valid
timestamp format
setting.
data ListAttacksResponse Source #
See: newListAttacksResponse
smart constructor.
Constructors
ListAttacksResponse' (Maybe [AttackSummary]) (Maybe Text) Int |
Instances
newListAttacksResponse Source #
Arguments
:: Int | |
-> ListAttacksResponse |
Create a value of ListAttacksResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attackSummaries:ListAttacksResponse'
, listAttacksResponse_attackSummaries
- The attack information for the specified time range.
ListAttacks
, listAttacksResponse_nextToken
- When you request a list of objects from Shield Advanced, if the response
does not include all of the remaining available objects, Shield Advanced
includes a NextToken
value in the response. You can retrieve the next
batch of objects by requesting the list again and providing the token
that was returned by the prior call in your request.
You can indicate the maximum number of objects that you want Shield
Advanced to return for a single call with the MaxResults
setting.
Shield Advanced will not return more than MaxResults
objects, but may
return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned
to you, the response will include a NextToken
value.
$sel:httpStatus:ListAttacksResponse'
, listAttacksResponse_httpStatus
- The response's http status code.
ListProtectionGroups
data ListProtectionGroups Source #
See: newListProtectionGroups
smart constructor.
Constructors
ListProtectionGroups' (Maybe InclusionProtectionGroupFilters) (Maybe Natural) (Maybe Text) |
Instances
newListProtectionGroups :: ListProtectionGroups Source #
Create a value of ListProtectionGroups
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:inclusionFilters:ListProtectionGroups'
, listProtectionGroups_inclusionFilters
- Narrows the set of protection groups that the call retrieves. You can
retrieve a single protection group by its name and you can retrieve all
protection groups that are configured with specific pattern or
aggregation settings. You can provide up to one criteria per filter
type. Shield Advanced returns the protection groups that exactly match
all of the search criteria that you provide.
$sel:maxResults:ListProtectionGroups'
, listProtectionGroups_maxResults
- The greatest number of objects that you want Shield Advanced to return
to the list request. Shield Advanced might return fewer objects than you
indicate in this setting, even if more objects are available. If there
are more objects remaining, Shield Advanced will always also return a
NextToken
value in the response.
The default setting is 20.
ListProtectionGroups
, listProtectionGroups_nextToken
- When you request a list of objects from Shield Advanced, if the response
does not include all of the remaining available objects, Shield Advanced
includes a NextToken
value in the response. You can retrieve the next
batch of objects by requesting the list again and providing the token
that was returned by the prior call in your request.
You can indicate the maximum number of objects that you want Shield
Advanced to return for a single call with the MaxResults
setting.
Shield Advanced will not return more than MaxResults
objects, but may
return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned
to you, the response will include a NextToken
value.
On your first call to a list operation, leave this setting empty.
data ListProtectionGroupsResponse Source #
See: newListProtectionGroupsResponse
smart constructor.
Constructors
ListProtectionGroupsResponse' (Maybe Text) Int [ProtectionGroup] |
Instances
newListProtectionGroupsResponse Source #
Create a value of ListProtectionGroupsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListProtectionGroups
, listProtectionGroupsResponse_nextToken
- When you request a list of objects from Shield Advanced, if the response
does not include all of the remaining available objects, Shield Advanced
includes a NextToken
value in the response. You can retrieve the next
batch of objects by requesting the list again and providing the token
that was returned by the prior call in your request.
You can indicate the maximum number of objects that you want Shield
Advanced to return for a single call with the MaxResults
setting.
Shield Advanced will not return more than MaxResults
objects, but may
return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned
to you, the response will include a NextToken
value.
$sel:httpStatus:ListProtectionGroupsResponse'
, listProtectionGroupsResponse_httpStatus
- The response's http status code.
$sel:protectionGroups:ListProtectionGroupsResponse'
, listProtectionGroupsResponse_protectionGroups
-
ListProtections (Paginated)
data ListProtections Source #
See: newListProtections
smart constructor.
Constructors
ListProtections' (Maybe InclusionProtectionFilters) (Maybe Natural) (Maybe Text) |
Instances
newListProtections :: ListProtections Source #
Create a value of ListProtections
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:inclusionFilters:ListProtections'
, listProtections_inclusionFilters
- Narrows the set of protections that the call retrieves. You can retrieve
a single protection by providing its name or the ARN (Amazon Resource
Name) of its protected resource. You can also retrieve all protections
for a specific resource type. You can provide up to one criteria per
filter type. Shield Advanced returns protections that exactly match all
of the filter criteria that you provide.
$sel:maxResults:ListProtections'
, listProtections_maxResults
- The greatest number of objects that you want Shield Advanced to return
to the list request. Shield Advanced might return fewer objects than you
indicate in this setting, even if more objects are available. If there
are more objects remaining, Shield Advanced will always also return a
NextToken
value in the response.
The default setting is 20.
ListProtections
, listProtections_nextToken
- When you request a list of objects from Shield Advanced, if the response
does not include all of the remaining available objects, Shield Advanced
includes a NextToken
value in the response. You can retrieve the next
batch of objects by requesting the list again and providing the token
that was returned by the prior call in your request.
You can indicate the maximum number of objects that you want Shield
Advanced to return for a single call with the MaxResults
setting.
Shield Advanced will not return more than MaxResults
objects, but may
return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned
to you, the response will include a NextToken
value.
On your first call to a list operation, leave this setting empty.
data ListProtectionsResponse Source #
See: newListProtectionsResponse
smart constructor.
Constructors
ListProtectionsResponse' (Maybe Text) (Maybe [Protection]) Int |
Instances
newListProtectionsResponse Source #
Create a value of ListProtectionsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListProtections
, listProtectionsResponse_nextToken
- When you request a list of objects from Shield Advanced, if the response
does not include all of the remaining available objects, Shield Advanced
includes a NextToken
value in the response. You can retrieve the next
batch of objects by requesting the list again and providing the token
that was returned by the prior call in your request.
You can indicate the maximum number of objects that you want Shield
Advanced to return for a single call with the MaxResults
setting.
Shield Advanced will not return more than MaxResults
objects, but may
return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned
to you, the response will include a NextToken
value.
$sel:protections:ListProtectionsResponse'
, listProtectionsResponse_protections
- The array of enabled Protection objects.
$sel:httpStatus:ListProtectionsResponse'
, listProtectionsResponse_httpStatus
- The response's http status code.
ListResourcesInProtectionGroup
data ListResourcesInProtectionGroup Source #
See: newListResourcesInProtectionGroup
smart constructor.
Instances
newListResourcesInProtectionGroup Source #
Create a value of ListResourcesInProtectionGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListResourcesInProtectionGroup'
, listResourcesInProtectionGroup_maxResults
- The greatest number of objects that you want Shield Advanced to return
to the list request. Shield Advanced might return fewer objects than you
indicate in this setting, even if more objects are available. If there
are more objects remaining, Shield Advanced will always also return a
NextToken
value in the response.
The default setting is 20.
ListResourcesInProtectionGroup
, listResourcesInProtectionGroup_nextToken
- When you request a list of objects from Shield Advanced, if the response
does not include all of the remaining available objects, Shield Advanced
includes a NextToken
value in the response. You can retrieve the next
batch of objects by requesting the list again and providing the token
that was returned by the prior call in your request.
You can indicate the maximum number of objects that you want Shield
Advanced to return for a single call with the MaxResults
setting.
Shield Advanced will not return more than MaxResults
objects, but may
return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned
to you, the response will include a NextToken
value.
On your first call to a list operation, leave this setting empty.
ListResourcesInProtectionGroup
, listResourcesInProtectionGroup_protectionGroupId
- 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.
data ListResourcesInProtectionGroupResponse Source #
See: newListResourcesInProtectionGroupResponse
smart constructor.
Constructors
ListResourcesInProtectionGroupResponse' (Maybe Text) Int [Text] |
Instances
newListResourcesInProtectionGroupResponse Source #
Arguments
:: Int | |
-> ListResourcesInProtectionGroupResponse |
Create a value of ListResourcesInProtectionGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListResourcesInProtectionGroup
, listResourcesInProtectionGroupResponse_nextToken
- When you request a list of objects from Shield Advanced, if the response
does not include all of the remaining available objects, Shield Advanced
includes a NextToken
value in the response. You can retrieve the next
batch of objects by requesting the list again and providing the token
that was returned by the prior call in your request.
You can indicate the maximum number of objects that you want Shield
Advanced to return for a single call with the MaxResults
setting.
Shield Advanced will not return more than MaxResults
objects, but may
return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned
to you, the response will include a NextToken
value.
$sel:httpStatus:ListResourcesInProtectionGroupResponse'
, listResourcesInProtectionGroupResponse_httpStatus
- The response's http status code.
ListResourcesInProtectionGroupResponse
, listResourcesInProtectionGroupResponse_resourceArns
- The Amazon Resource Names (ARNs) of the resources that are included in
the protection group.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Constructors
ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
:: Text | |
-> ListTagsForResource |
Create a value of ListTagsForResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceARN:ListTagsForResource'
, listTagsForResource_resourceARN
- The Amazon Resource Name (ARN) of the resource to get tags for.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
Constructors
ListTagsForResourceResponse' (Maybe [Tag]) Int |
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:ListTagsForResourceResponse'
, listTagsForResourceResponse_tags
- A list of tag key and value pairs associated with the specified
resource.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Constructors
TagResource' Text [Tag] |
Instances
Arguments
:: Text | |
-> TagResource |
Create a value of TagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceARN:TagResource'
, tagResource_resourceARN
- The Amazon Resource Name (ARN) of the resource that you want to add or
update tags for.
$sel:tags:TagResource'
, tagResource_tags
- The tags that you want to modify or add to the resource.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Constructors
TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
:: Int | |
-> TagResourceResponse |
Create a value of TagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:TagResourceResponse'
, tagResourceResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Constructors
UntagResource' Text [Text] |
Instances
Arguments
:: Text | |
-> UntagResource |
Create a value of UntagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceARN:UntagResource'
, untagResource_resourceARN
- The Amazon Resource Name (ARN) of the resource that you want to remove
tags from.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- The tag key for each tag that you want to remove from the resource.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Constructors
UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UntagResourceResponse'
, untagResourceResponse_httpStatus
- The response's http status code.
UpdateApplicationLayerAutomaticResponse
data UpdateApplicationLayerAutomaticResponse Source #
See: newUpdateApplicationLayerAutomaticResponse
smart constructor.
Instances
newUpdateApplicationLayerAutomaticResponse Source #
Arguments
:: Text | |
-> ResponseAction | |
-> UpdateApplicationLayerAutomaticResponse |
Create a value of UpdateApplicationLayerAutomaticResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateApplicationLayerAutomaticResponse
, updateApplicationLayerAutomaticResponse_resourceArn
- The ARN (Amazon Resource Name) of the resource.
UpdateApplicationLayerAutomaticResponse
, updateApplicationLayerAutomaticResponse_action
- Specifies the action setting that Shield Advanced should use in the WAF
rules that it creates on behalf of the protected resource in response to
DDoS attacks. You specify this as part of the configuration for the
automatic application layer DDoS mitigation feature, when you enable or
update automatic mitigation. Shield Advanced creates the WAF rules in a
Shield Advanced-managed rule group, inside the web ACL that you have
associated with the resource.
data UpdateApplicationLayerAutomaticResponseResponse Source #
See: newUpdateApplicationLayerAutomaticResponseResponse
smart constructor.
Constructors
UpdateApplicationLayerAutomaticResponseResponse' Int |
Instances
newUpdateApplicationLayerAutomaticResponseResponse Source #
Arguments
:: Int |
|
-> UpdateApplicationLayerAutomaticResponseResponse |
Create a value of UpdateApplicationLayerAutomaticResponseResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateApplicationLayerAutomaticResponseResponse'
, updateApplicationLayerAutomaticResponseResponse_httpStatus
- The response's http status code.
UpdateEmergencyContactSettings
data UpdateEmergencyContactSettings Source #
See: newUpdateEmergencyContactSettings
smart constructor.
Constructors
UpdateEmergencyContactSettings' (Maybe [EmergencyContact]) |
Instances
newUpdateEmergencyContactSettings :: UpdateEmergencyContactSettings Source #
Create a value of UpdateEmergencyContactSettings
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:emergencyContactList:UpdateEmergencyContactSettings'
, updateEmergencyContactSettings_emergencyContactList
- A list of email addresses and phone numbers that the Shield Response
Team (SRT) can use to contact you if you have proactive engagement
enabled, for escalations to the SRT and to initiate proactive customer
support.
If you have proactive engagement enabled, the contact list must include at least one phone number.
data UpdateEmergencyContactSettingsResponse Source #
See: newUpdateEmergencyContactSettingsResponse
smart constructor.
Constructors
UpdateEmergencyContactSettingsResponse' Int |
Instances
newUpdateEmergencyContactSettingsResponse Source #
Arguments
:: Int | |
-> UpdateEmergencyContactSettingsResponse |
Create a value of UpdateEmergencyContactSettingsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateEmergencyContactSettingsResponse'
, updateEmergencyContactSettingsResponse_httpStatus
- The response's http status code.
UpdateProtectionGroup
data UpdateProtectionGroup Source #
See: newUpdateProtectionGroup
smart constructor.
Constructors
UpdateProtectionGroup' (Maybe [Text]) (Maybe ProtectedResourceType) Text ProtectionGroupAggregation ProtectionGroupPattern |
Instances
newUpdateProtectionGroup Source #
Arguments
:: Text | |
-> ProtectionGroupAggregation | |
-> ProtectionGroupPattern | |
-> UpdateProtectionGroup |
Create a value of UpdateProtectionGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateProtectionGroup
, updateProtectionGroup_members
- 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.
UpdateProtectionGroup
, updateProtectionGroup_resourceType
- 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.
UpdateProtectionGroup
, updateProtectionGroup_protectionGroupId
- 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.
UpdateProtectionGroup
, updateProtectionGroup_aggregation
- Defines how 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 Amazon CloudFront distributions and origin resources for CloudFront distributions.
UpdateProtectionGroup
, updateProtectionGroup_pattern
- 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.
data UpdateProtectionGroupResponse Source #
See: newUpdateProtectionGroupResponse
smart constructor.
Constructors
UpdateProtectionGroupResponse' Int |
Instances
newUpdateProtectionGroupResponse Source #
Create a value of UpdateProtectionGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateProtectionGroupResponse'
, updateProtectionGroupResponse_httpStatus
- The response's http status code.
UpdateSubscription
data UpdateSubscription Source #
See: newUpdateSubscription
smart constructor.
Constructors
UpdateSubscription' (Maybe AutoRenew) |
Instances
newUpdateSubscription :: UpdateSubscription Source #
Create a value of UpdateSubscription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateSubscription
, updateSubscription_autoRenew
- 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.
data UpdateSubscriptionResponse Source #
See: newUpdateSubscriptionResponse
smart constructor.
Constructors
UpdateSubscriptionResponse' Int |
Instances
newUpdateSubscriptionResponse Source #
Create a value of UpdateSubscriptionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateSubscriptionResponse'
, updateSubscriptionResponse_httpStatus
- The response's http status code.
Types
ApplicationLayerAutomaticResponseStatus
newtype ApplicationLayerAutomaticResponseStatus Source #
Constructors
ApplicationLayerAutomaticResponseStatus' | |
Bundled Patterns
pattern ApplicationLayerAutomaticResponseStatus_DISABLED :: ApplicationLayerAutomaticResponseStatus | |
pattern ApplicationLayerAutomaticResponseStatus_ENABLED :: ApplicationLayerAutomaticResponseStatus |
Instances
AttackLayer
newtype AttackLayer Source #
Constructors
AttackLayer' | |
Fields |
Bundled Patterns
pattern AttackLayer_APPLICATION :: AttackLayer | |
pattern AttackLayer_NETWORK :: AttackLayer |
Instances
AttackPropertyIdentifier
newtype AttackPropertyIdentifier Source #
Constructors
AttackPropertyIdentifier' | |
Fields |
Bundled Patterns
Instances
AutoRenew
Constructors
AutoRenew' | |
Fields |
Bundled Patterns
pattern AutoRenew_DISABLED :: AutoRenew | |
pattern AutoRenew_ENABLED :: AutoRenew |
Instances
ProactiveEngagementStatus
newtype ProactiveEngagementStatus Source #
Constructors
ProactiveEngagementStatus' | |
Fields |
Bundled Patterns
Instances
ProtectedResourceType
newtype ProtectedResourceType Source #
Constructors
ProtectedResourceType' | |
Fields |
Bundled Patterns
Instances
ProtectionGroupAggregation
newtype ProtectionGroupAggregation Source #
Constructors
ProtectionGroupAggregation' | |
Fields |
Bundled Patterns
Instances
ProtectionGroupPattern
newtype ProtectionGroupPattern Source #
Constructors
ProtectionGroupPattern' | |
Fields |
Bundled Patterns
Instances
SubResourceType
newtype SubResourceType Source #
Constructors
SubResourceType' | |
Fields |
Bundled Patterns
pattern SubResourceType_IP :: SubResourceType | |
pattern SubResourceType_URL :: SubResourceType |
Instances
SubscriptionState
newtype SubscriptionState Source #
Constructors
SubscriptionState' | |
Fields |
Bundled Patterns
pattern SubscriptionState_ACTIVE :: SubscriptionState | |
pattern SubscriptionState_INACTIVE :: SubscriptionState |
Instances
Unit
Bundled Patterns
pattern Unit_BITS :: Unit | |
pattern Unit_BYTES :: Unit | |
pattern Unit_PACKETS :: Unit | |
pattern Unit_REQUESTS :: Unit |
Instances
ApplicationLayerAutomaticResponseConfiguration
data ApplicationLayerAutomaticResponseConfiguration Source #
The automatic application layer DDoS mitigation settings for a Protection. This configuration determines whether Shield Advanced automatically manages rules in the web ACL in order to respond to application layer events that Shield Advanced determines to be DDoS attacks.
See: newApplicationLayerAutomaticResponseConfiguration
smart constructor.
Constructors
ApplicationLayerAutomaticResponseConfiguration' ApplicationLayerAutomaticResponseStatus ResponseAction |
Instances
newApplicationLayerAutomaticResponseConfiguration Source #
Arguments
:: ApplicationLayerAutomaticResponseStatus | |
-> ResponseAction | |
-> ApplicationLayerAutomaticResponseConfiguration |
Create a value of ApplicationLayerAutomaticResponseConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:ApplicationLayerAutomaticResponseConfiguration'
, applicationLayerAutomaticResponseConfiguration_status
- Indicates whether automatic application layer DDoS mitigation is enabled
for the protection.
$sel:action:ApplicationLayerAutomaticResponseConfiguration'
, applicationLayerAutomaticResponseConfiguration_action
- Specifies the action setting that Shield Advanced should use in the WAF
rules that it creates on behalf of the protected resource in response to
DDoS attacks. You specify this as part of the configuration for the
automatic application layer DDoS mitigation feature, when you enable or
update automatic mitigation. Shield Advanced creates the WAF rules in a
Shield Advanced-managed rule group, inside the web ACL that you have
associated with the resource.
AttackDetail
data AttackDetail Source #
The details of a DDoS attack.
See: newAttackDetail
smart constructor.
Constructors
AttackDetail' (Maybe [SummarizedCounter]) (Maybe Text) (Maybe [AttackProperty]) (Maybe POSIX) (Maybe [Mitigation]) (Maybe Text) (Maybe POSIX) (Maybe [SubResourceSummary]) |
Instances
newAttackDetail :: AttackDetail Source #
Create a value of AttackDetail
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attackCounters:AttackDetail'
, attackDetail_attackCounters
- List of counters that describe the attack for the specified time period.
$sel:attackId:AttackDetail'
, attackDetail_attackId
- The unique identifier (ID) of the attack.
$sel:attackProperties:AttackDetail'
, attackDetail_attackProperties
- The array of objects that provide details of the Shield event.
For infrastructure layer events (L3 and L4 events), you can view metrics for top contributors in Amazon CloudWatch metrics. For more information, see Shield metrics and alarms in the WAF Developer Guide.
$sel:endTime:AttackDetail'
, attackDetail_endTime
- The time the attack ended, in Unix time in seconds.
$sel:mitigations:AttackDetail'
, attackDetail_mitigations
- List of mitigation actions taken for the attack.
$sel:resourceArn:AttackDetail'
, attackDetail_resourceArn
- The ARN (Amazon Resource Name) of the resource that was attacked.
$sel:startTime:AttackDetail'
, attackDetail_startTime
- The time the attack started, in Unix time in seconds.
$sel:subResources:AttackDetail'
, attackDetail_subResources
- If applicable, additional detail about the resource being attacked, for
example, IP address or URL.
AttackProperty
data AttackProperty Source #
Details of a Shield event. This is provided as part of an AttackDetail.
See: newAttackProperty
smart constructor.
Constructors
AttackProperty' (Maybe AttackLayer) (Maybe AttackPropertyIdentifier) (Maybe [Contributor]) (Maybe Integer) (Maybe Unit) |
Instances
newAttackProperty :: AttackProperty Source #
Create a value of AttackProperty
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attackLayer:AttackProperty'
, attackProperty_attackLayer
- The type of Shield event that was observed. NETWORK
indicates layer 3
and layer 4 events and APPLICATION
indicates layer 7 events.
For infrastructure layer events (L3 and L4 events), you can view metrics for top contributors in Amazon CloudWatch metrics. For more information, see Shield metrics and alarms in the WAF Developer Guide.
$sel:attackPropertyIdentifier:AttackProperty'
, attackProperty_attackPropertyIdentifier
- Defines the Shield event property information that is provided. The
WORDPRESS_PINGBACK_REFLECTOR
and WORDPRESS_PINGBACK_SOURCE
values
are valid only for WordPress reflective pingback events.
$sel:topContributors:AttackProperty'
, attackProperty_topContributors
- Contributor objects for the top five contributors to a Shield event. A
contributor is a source of traffic that Shield Advanced identifies as
responsible for some or all of an event.
$sel:total:AttackProperty'
, attackProperty_total
- The total contributions made to this Shield event by all contributors.
$sel:unit:AttackProperty'
, attackProperty_unit
- The unit used for the Contributor
Value
property.
AttackStatisticsDataItem
data AttackStatisticsDataItem Source #
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.
See: newAttackStatisticsDataItem
smart constructor.
Constructors
AttackStatisticsDataItem' (Maybe AttackVolume) Integer |
Instances
newAttackStatisticsDataItem Source #
Create a value of AttackStatisticsDataItem
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attackVolume:AttackStatisticsDataItem'
, attackStatisticsDataItem_attackVolume
- Information about the volume of attacks during the time period. If the
accompanying AttackCount
is zero, this setting might be empty.
$sel:attackCount:AttackStatisticsDataItem'
, attackStatisticsDataItem_attackCount
- The number of attacks detected during the time period. This is always
present, but might be zero.
AttackSummary
data AttackSummary Source #
Summarizes all DDoS attacks for a specified time period.
See: newAttackSummary
smart constructor.
Constructors
AttackSummary' (Maybe Text) (Maybe [AttackVectorDescription]) (Maybe POSIX) (Maybe Text) (Maybe POSIX) |
Instances
newAttackSummary :: AttackSummary Source #
Create a value of AttackSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attackId:AttackSummary'
, attackSummary_attackId
- The unique identifier (ID) of the attack.
$sel:attackVectors:AttackSummary'
, attackSummary_attackVectors
- The list of attacks for a specified time period.
$sel:endTime:AttackSummary'
, attackSummary_endTime
- The end time of the attack, in Unix time in seconds.
$sel:resourceArn:AttackSummary'
, attackSummary_resourceArn
- The ARN (Amazon Resource Name) of the resource that was attacked.
$sel:startTime:AttackSummary'
, attackSummary_startTime
- The start time of the attack, in Unix time in seconds.
AttackVectorDescription
data AttackVectorDescription Source #
Describes the attack.
See: newAttackVectorDescription
smart constructor.
Constructors
AttackVectorDescription' Text |
Instances
newAttackVectorDescription Source #
Create a value of AttackVectorDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:vectorType:AttackVectorDescription'
, attackVectorDescription_vectorType
- 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
AttackVolume
data AttackVolume Source #
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.
See: newAttackVolume
smart constructor.
Constructors
AttackVolume' (Maybe AttackVolumeStatistics) (Maybe AttackVolumeStatistics) (Maybe AttackVolumeStatistics) |
Instances
newAttackVolume :: AttackVolume Source #
Create a value of AttackVolume
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bitsPerSecond:AttackVolume'
, attackVolume_bitsPerSecond
- A statistics object that uses bits per second as the unit. This is
included for network level attacks.
$sel:packetsPerSecond:AttackVolume'
, attackVolume_packetsPerSecond
- A statistics object that uses packets per second as the unit. This is
included for network level attacks.
$sel:requestsPerSecond:AttackVolume'
, attackVolume_requestsPerSecond
- 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.
AttackVolumeStatistics
data AttackVolumeStatistics Source #
Statistics objects for the various data types in AttackVolume.
See: newAttackVolumeStatistics
smart constructor.
Constructors
AttackVolumeStatistics' Double |
Instances
newAttackVolumeStatistics Source #
Arguments
:: Double | |
-> AttackVolumeStatistics |
Create a value of AttackVolumeStatistics
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:max:AttackVolumeStatistics'
, attackVolumeStatistics_max
- The maximum attack volume observed for the given unit.
BlockAction
data BlockAction Source #
Specifies that Shield Advanced should configure its WAF rules with the
WAF Block
action.
This is only used in the context of the ResponseAction
setting.
JSON specification: "Block": {}
See: newBlockAction
smart constructor.
Constructors
BlockAction' | |
Instances
newBlockAction :: BlockAction Source #
Create a value of BlockAction
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
Contributor
data Contributor Source #
A contributor to the attack and their contribution.
See: newContributor
smart constructor.
Constructors
Contributor' (Maybe Text) (Maybe Integer) |
Instances
newContributor :: Contributor Source #
Create a value of Contributor
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:Contributor'
, contributor_name
- The name of the contributor. The type of name that you'll find here
depends on the AttackPropertyIdentifier
setting in the
AttackProperty
where this contributor is defined. For example, if the
AttackPropertyIdentifier
is SOURCE_COUNTRY
, the Name
could be
United States
.
$sel:value:Contributor'
, contributor_value
- The contribution of this contributor expressed in Protection units. For
example 10,000
.
CountAction
data CountAction Source #
Specifies that Shield Advanced should configure its WAF rules with the
WAF Count
action.
This is only used in the context of the ResponseAction
setting.
JSON specification: "Count": {}
See: newCountAction
smart constructor.
Constructors
CountAction' | |
Instances
newCountAction :: CountAction Source #
Create a value of CountAction
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
EmergencyContact
data EmergencyContact Source #
Contact information that the SRT can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.
See: newEmergencyContact
smart constructor.
Instances
Arguments
:: Text | |
-> EmergencyContact |
Create a value of EmergencyContact
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:contactNotes:EmergencyContact'
, emergencyContact_contactNotes
- Additional notes regarding the contact.
$sel:phoneNumber:EmergencyContact'
, emergencyContact_phoneNumber
- The phone number for the contact.
$sel:emailAddress:EmergencyContact'
, emergencyContact_emailAddress
- The email address for the contact.
InclusionProtectionFilters
data InclusionProtectionFilters Source #
Narrows the set of protections that the call retrieves. You can retrieve a single protection by providing its name or the ARN (Amazon Resource Name) of its protected resource. You can also retrieve all protections for a specific resource type. You can provide up to one criteria per filter type. Shield Advanced returns protections that exactly match all of the filter criteria that you provide.
See: newInclusionProtectionFilters
smart constructor.
Constructors
InclusionProtectionFilters' (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty ProtectedResourceType)) |
Instances
newInclusionProtectionFilters :: InclusionProtectionFilters Source #
Create a value of InclusionProtectionFilters
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:protectionNames:InclusionProtectionFilters'
, inclusionProtectionFilters_protectionNames
- The name of the protection that you want to retrieve.
$sel:resourceArns:InclusionProtectionFilters'
, inclusionProtectionFilters_resourceArns
- The ARN (Amazon Resource Name) of the resource whose protection you want
to retrieve.
$sel:resourceTypes:InclusionProtectionFilters'
, inclusionProtectionFilters_resourceTypes
- The type of protected resource whose protections you want to retrieve.
InclusionProtectionGroupFilters
data InclusionProtectionGroupFilters Source #
Narrows the set of protection groups that the call retrieves. You can retrieve a single protection group by its name and you can retrieve all protection groups that are configured with a specific pattern, aggregation, or resource type. You can provide up to one criteria per filter type. Shield Advanced returns the protection groups that exactly match all of the search criteria that you provide.
See: newInclusionProtectionGroupFilters
smart constructor.
Constructors
InclusionProtectionGroupFilters' (Maybe (NonEmpty ProtectionGroupAggregation)) (Maybe (NonEmpty ProtectionGroupPattern)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty ProtectedResourceType)) |
Instances
newInclusionProtectionGroupFilters :: InclusionProtectionGroupFilters Source #
Create a value of InclusionProtectionGroupFilters
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:aggregations:InclusionProtectionGroupFilters'
, inclusionProtectionGroupFilters_aggregations
- The aggregation setting of the protection groups that you want to
retrieve.
$sel:patterns:InclusionProtectionGroupFilters'
, inclusionProtectionGroupFilters_patterns
- The pattern specification of the protection groups that you want to
retrieve.
$sel:protectionGroupIds:InclusionProtectionGroupFilters'
, inclusionProtectionGroupFilters_protectionGroupIds
- The ID of the protection group that you want to retrieve.
$sel:resourceTypes:InclusionProtectionGroupFilters'
, inclusionProtectionGroupFilters_resourceTypes
- The resource type configuration of the protection groups that you want
to retrieve. In the protection group configuration, you specify the
resource type when you set the group's Pattern
to BY_RESOURCE_TYPE
.
Limit
Specifies how many protections of a given type you can create.
See: newLimit
smart constructor.
Instances
FromJSON Limit Source # | |
Generic Limit Source # | |
Read Limit Source # | |
Show Limit Source # | |
NFData Limit Source # | |
Defined in Amazonka.Shield.Types.Limit | |
Eq Limit Source # | |
Hashable Limit Source # | |
Defined in Amazonka.Shield.Types.Limit | |
type Rep Limit Source # | |
Defined in Amazonka.Shield.Types.Limit type Rep Limit = D1 ('MetaData "Limit" "Amazonka.Shield.Types.Limit" "amazonka-shield-2.0-Cz9Fa9OSQ93AE4UCXBDcFo" 'False) (C1 ('MetaCons "Limit'" 'PrefixI 'True) (S1 ('MetaSel ('Just "max") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
Create a value of Limit
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:max:Limit'
, limit_max
- The maximum number of protections that can be created for the specified
Type
.
$sel:type':Limit'
, limit_type
- The type of protection.
Mitigation
data Mitigation Source #
The mitigation applied to a DDoS attack.
See: newMitigation
smart constructor.
Constructors
Mitigation' (Maybe Text) |
Instances
newMitigation :: Mitigation Source #
Create a value of Mitigation
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:mitigationName:Mitigation'
, mitigation_mitigationName
- 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: newProtection
smart constructor.
Constructors
Protection' (Maybe ApplicationLayerAutomaticResponseConfiguration) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newProtection :: Protection Source #
Create a value of Protection
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationLayerAutomaticResponseConfiguration:Protection'
, protection_applicationLayerAutomaticResponseConfiguration
- The automatic application layer DDoS mitigation settings for the
protection. This configuration determines whether Shield Advanced
automatically manages rules in the web ACL in order to respond to
application layer events that Shield Advanced determines to be DDoS
attacks.
$sel:healthCheckIds:Protection'
, protection_healthCheckIds
- The unique identifier (ID) for the Route 53 health check that's
associated with the protection.
$sel:id:Protection'
, protection_id
- The unique identifier (ID) of the protection.
$sel:name:Protection'
, protection_name
- The name of the protection. For example, My CloudFront distributions
.
$sel:protectionArn:Protection'
, protection_protectionArn
- The ARN (Amazon Resource Name) of the protection.
$sel:resourceArn:Protection'
, protection_resourceArn
- The ARN (Amazon Resource Name) of the Amazon Web Services resource that
is protected.
ProtectionGroup
data ProtectionGroup Source #
A grouping of protected resources that you and Shield Advanced can monitor as a collective. This resource grouping improves the accuracy of detection and reduces false positives.
See: newProtectionGroup
smart constructor.
Constructors
ProtectionGroup' (Maybe Text) (Maybe ProtectedResourceType) Text ProtectionGroupAggregation ProtectionGroupPattern [Text] |
Instances
Arguments
:: Text | |
-> ProtectionGroupAggregation | |
-> ProtectionGroupPattern | |
-> ProtectionGroup |
Create a value of ProtectionGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:protectionGroupArn:ProtectionGroup'
, protectionGroup_protectionGroupArn
- The ARN (Amazon Resource Name) of the protection group.
$sel:resourceType:ProtectionGroup'
, protectionGroup_resourceType
- 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.
$sel:protectionGroupId:ProtectionGroup'
, protectionGroup_protectionGroupId
- 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.
$sel:aggregation:ProtectionGroup'
, protectionGroup_aggregation
- Defines how 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 Amazon CloudFront distributions and origin resources for CloudFront distributions.
$sel:pattern':ProtectionGroup'
, protectionGroup_pattern
- 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 ARNs (Amazon Resource Names), or include all
resources of a specified resource type.
$sel:members:ProtectionGroup'
, protectionGroup_members
- The ARNs (Amazon Resource Names) 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.
ProtectionGroupArbitraryPatternLimits
data ProtectionGroupArbitraryPatternLimits Source #
Limits settings on protection groups with arbitrary pattern type.
See: newProtectionGroupArbitraryPatternLimits
smart constructor.
Constructors
ProtectionGroupArbitraryPatternLimits' Integer |
Instances
newProtectionGroupArbitraryPatternLimits Source #
Arguments
:: Integer | |
-> ProtectionGroupArbitraryPatternLimits |
Create a value of ProtectionGroupArbitraryPatternLimits
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxMembers:ProtectionGroupArbitraryPatternLimits'
, protectionGroupArbitraryPatternLimits_maxMembers
- The maximum number of resources you can specify for a single arbitrary
pattern in a protection group.
ProtectionGroupLimits
data ProtectionGroupLimits Source #
Limits settings on protection groups for your subscription.
See: newProtectionGroupLimits
smart constructor.
Instances
newProtectionGroupLimits Source #
Arguments
:: Integer | |
-> ProtectionGroupPatternTypeLimits | |
-> ProtectionGroupLimits |
Create a value of ProtectionGroupLimits
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxProtectionGroups:ProtectionGroupLimits'
, protectionGroupLimits_maxProtectionGroups
- The maximum number of protection groups that you can have at one time.
$sel:patternTypeLimits:ProtectionGroupLimits'
, protectionGroupLimits_patternTypeLimits
- Limits settings by pattern type in the protection groups for your
subscription.
ProtectionGroupPatternTypeLimits
data ProtectionGroupPatternTypeLimits Source #
Limits settings by pattern type in the protection groups for your subscription.
See: newProtectionGroupPatternTypeLimits
smart constructor.
Instances
newProtectionGroupPatternTypeLimits Source #
Arguments
:: ProtectionGroupArbitraryPatternLimits |
|
-> ProtectionGroupPatternTypeLimits |
Create a value of ProtectionGroupPatternTypeLimits
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arbitraryPatternLimits:ProtectionGroupPatternTypeLimits'
, protectionGroupPatternTypeLimits_arbitraryPatternLimits
- Limits settings on protection groups with arbitrary pattern type.
ProtectionLimits
data ProtectionLimits Source #
Limits settings on protections for your subscription.
See: newProtectionLimits
smart constructor.
Constructors
ProtectionLimits' [Limit] |
Instances
newProtectionLimits :: ProtectionLimits Source #
Create a value of ProtectionLimits
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:protectedResourceTypeLimits:ProtectionLimits'
, protectionLimits_protectedResourceTypeLimits
- The maximum number of resource types that you can specify in a
protection.
ResponseAction
data ResponseAction Source #
Specifies the action setting that Shield Advanced should use in the WAF rules that it creates on behalf of the protected resource in response to DDoS attacks. You specify this as part of the configuration for the automatic application layer DDoS mitigation feature, when you enable or update automatic mitigation. Shield Advanced creates the WAF rules in a Shield Advanced-managed rule group, inside the web ACL that you have associated with the resource.
See: newResponseAction
smart constructor.
Constructors
ResponseAction' (Maybe BlockAction) (Maybe CountAction) |
Instances
newResponseAction :: ResponseAction Source #
Create a value of ResponseAction
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:block:ResponseAction'
, responseAction_block
- Specifies that Shield Advanced should configure its WAF rules with the
WAF Block
action.
You must specify exactly one action, either Block
or Count
.
$sel:count:ResponseAction'
, responseAction_count
- Specifies that Shield Advanced should configure its WAF rules with the
WAF Count
action.
You must specify exactly one action, either Block
or Count
.
SubResourceSummary
data SubResourceSummary Source #
The attack information for the specified SubResource.
See: newSubResourceSummary
smart constructor.
Constructors
SubResourceSummary' (Maybe [SummarizedAttackVector]) (Maybe [SummarizedCounter]) (Maybe Text) (Maybe SubResourceType) |
Instances
newSubResourceSummary :: SubResourceSummary Source #
Create a value of SubResourceSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attackVectors:SubResourceSummary'
, subResourceSummary_attackVectors
- The list of attack types and associated counters.
$sel:counters:SubResourceSummary'
, subResourceSummary_counters
- The counters that describe the details of the attack.
$sel:id:SubResourceSummary'
, subResourceSummary_id
- The unique identifier (ID) of the SubResource
.
$sel:type':SubResourceSummary'
, subResourceSummary_type
- The SubResource
type.
Subscription
data Subscription Source #
Information about the Shield Advanced subscription for an account.
See: newSubscription
smart constructor.
Constructors
Subscription' (Maybe AutoRenew) (Maybe POSIX) (Maybe [Limit]) (Maybe ProactiveEngagementStatus) (Maybe POSIX) (Maybe Text) (Maybe Natural) SubscriptionLimits |
Instances
Create a value of Subscription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:autoRenew:Subscription'
, subscription_autoRenew
- 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.
$sel:endTime:Subscription'
, subscription_endTime
- The date and time your subscription will end.
$sel:limits:Subscription'
, subscription_limits
- Specifies how many protections of a given type you can create.
$sel:proactiveEngagementStatus:Subscription'
, subscription_proactiveEngagementStatus
- If ENABLED
, the Shield Response Team (SRT) will use email and phone to
notify contacts about escalations to the SRT 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 SRT will not proactively notify contacts about
escalations or to initiate proactive customer support.
$sel:startTime:Subscription'
, subscription_startTime
- The start time of the subscription, in Unix time in seconds.
$sel:subscriptionArn:Subscription'
, subscription_subscriptionArn
- The ARN (Amazon Resource Name) of the subscription.
$sel:timeCommitmentInSeconds:Subscription'
, subscription_timeCommitmentInSeconds
- The length, in seconds, of the Shield Advanced subscription for the
account.
$sel:subscriptionLimits:Subscription'
, subscription_subscriptionLimits
- Limits settings for your subscription.
SubscriptionLimits
data SubscriptionLimits Source #
Limits settings for your subscription.
See: newSubscriptionLimits
smart constructor.
Constructors
SubscriptionLimits' ProtectionLimits ProtectionGroupLimits |
Instances
newSubscriptionLimits Source #
Arguments
:: ProtectionLimits | |
-> ProtectionGroupLimits | |
-> SubscriptionLimits |
Create a value of SubscriptionLimits
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:protectionLimits:SubscriptionLimits'
, subscriptionLimits_protectionLimits
- Limits settings on protections for your subscription.
$sel:protectionGroupLimits:SubscriptionLimits'
, subscriptionLimits_protectionGroupLimits
- Limits settings on protection groups for your subscription.
SummarizedAttackVector
data SummarizedAttackVector Source #
A summary of information about the attack.
See: newSummarizedAttackVector
smart constructor.
Constructors
SummarizedAttackVector' (Maybe [SummarizedCounter]) Text |
Instances
newSummarizedAttackVector Source #
Create a value of SummarizedAttackVector
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:vectorCounters:SummarizedAttackVector'
, summarizedAttackVector_vectorCounters
- The list of counters that describe the details of the attack.
$sel:vectorType:SummarizedAttackVector'
, summarizedAttackVector_vectorType
- The attack type, for example, SNMP reflection or SYN flood.
SummarizedCounter
data SummarizedCounter Source #
The counter that describes a DDoS attack.
See: newSummarizedCounter
smart constructor.
Constructors
SummarizedCounter' (Maybe Double) (Maybe Double) (Maybe Int) (Maybe Text) (Maybe Double) (Maybe Text) |
Instances
newSummarizedCounter :: SummarizedCounter Source #
Create a value of SummarizedCounter
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:average:SummarizedCounter'
, summarizedCounter_average
- The average value of the counter for a specified time period.
$sel:max:SummarizedCounter'
, summarizedCounter_max
- The maximum value of the counter for a specified time period.
$sel:n:SummarizedCounter'
, summarizedCounter_n
- The number of counters for a specified time period.
$sel:name:SummarizedCounter'
, summarizedCounter_name
- The counter name.
$sel:sum:SummarizedCounter'
, summarizedCounter_sum
- The total of counter values for a specified time period.
$sel:unit:SummarizedCounter'
, summarizedCounter_unit
- The unit of the counters.
Tag
A tag associated with an Amazon Web Services 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 Amazon Web Services resource, up to 50 tags for a resource.
See: newTag
smart constructor.
Instances
FromJSON Tag Source # | |
ToJSON Tag Source # | |
Defined in Amazonka.Shield.Types.Tag | |
Generic Tag Source # | |
Read Tag Source # | |
Show Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.Shield.Types.Tag | |
Eq Tag Source # | |
Hashable Tag Source # | |
Defined in Amazonka.Shield.Types.Tag | |
type Rep Tag Source # | |
Defined in Amazonka.Shield.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.Shield.Types.Tag" "amazonka-shield-2.0-Cz9Fa9OSQ93AE4UCXBDcFo" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
Create a value of Tag
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Tag'
, tag_key
- 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.
$sel:value:Tag'
, tag_value
- 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.
TimeRange
The time range.
See: newTimeRange
smart constructor.
Constructors
TimeRange' (Maybe POSIX) (Maybe POSIX) |
Instances
FromJSON TimeRange Source # | |
ToJSON TimeRange Source # | |
Defined in Amazonka.Shield.Types.TimeRange | |
Generic TimeRange Source # | |
Read TimeRange Source # | |
Show TimeRange Source # | |
NFData TimeRange Source # | |
Defined in Amazonka.Shield.Types.TimeRange | |
Eq TimeRange Source # | |
Hashable TimeRange Source # | |
Defined in Amazonka.Shield.Types.TimeRange | |
type Rep TimeRange Source # | |
Defined in Amazonka.Shield.Types.TimeRange type Rep TimeRange = D1 ('MetaData "TimeRange" "Amazonka.Shield.Types.TimeRange" "amazonka-shield-2.0-Cz9Fa9OSQ93AE4UCXBDcFo" 'False) (C1 ('MetaCons "TimeRange'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromInclusive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "toExclusive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) |
newTimeRange :: TimeRange Source #
Create a value of TimeRange
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fromInclusive:TimeRange'
, timeRange_fromInclusive
- The start time, in Unix time in seconds.
$sel:toExclusive:TimeRange'
, timeRange_toExclusive
- The end time, in Unix time in seconds.