@datafire/amazonaws_shield NPM

@datafire/amazonaws_shield

Client library for AWS Shield

Installation and Usage

npm install --save @datafire/amazonaws_shield

let amazonaws_shield = require('@datafire/amazonaws_shield').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_shield.CreateProtection({
  "Name": "",
  "ResourceArn": ""
}).then(data => {
  console.log(data);
});

Description

AWS Shield Advanced This is the AWS Shield Advanced API Reference. This guide is for developers who need detailed information about the AWS Shield Advanced API actions, data types, and errors. For detailed information about AWS WAF and AWS Shield Advanced features and an overview of how to use the AWS WAF and AWS Shield Advanced APIs, see the AWS WAF and AWS Shield Developer Guide.

Actions

CreateProtection

amazonaws_shield.CreateProtection({
  "Name": "",
  "ResourceArn": ""
}, context)

Input

input object
- Name required ProtectionName
- ResourceArn required ResourceArn

Output

output CreateProtectionResponse

CreateSubscription

amazonaws_shield.CreateSubscription({}, context)

Input

input object

Output

output CreateSubscriptionResponse

DeleteProtection

amazonaws_shield.DeleteProtection({
  "ProtectionId": ""
}, context)

Input

input object
- ProtectionId required ProtectionId

Output

output DeleteProtectionResponse

DeleteSubscription

amazonaws_shield.DeleteSubscription({}, context)

Input

input object

Output

output DeleteSubscriptionResponse

DescribeAttack

amazonaws_shield.DescribeAttack({
  "AttackId": ""
}, context)

Input

input object
- AttackId required AttackId

Output

output DescribeAttackResponse

DescribeProtection

amazonaws_shield.DescribeProtection({
  "ProtectionId": ""
}, context)

Input

input object
- ProtectionId required ProtectionId

Output

output DescribeProtectionResponse

DescribeSubscription

amazonaws_shield.DescribeSubscription({}, context)

Input

input object

Output

output DescribeSubscriptionResponse

GetSubscriptionState

amazonaws_shield.GetSubscriptionState({}, context)

Input

input object

Output

output GetSubscriptionStateResponse

ListAttacks

amazonaws_shield.ListAttacks({}, context)

Input

input object
- EndTime TimeRange
- MaxResults MaxResults
- NextToken Token
- ResourceArns ResourceArnFilterList
- StartTime TimeRange

Output

output ListAttacksResponse

ListProtections

amazonaws_shield.ListProtections({}, context)

Input

input object
- MaxResults MaxResults
- NextToken Token

Output

output ListProtectionsResponse

Definitions

AttackDetail

AttackDetail object: The details of a DDoS attack.
- AttackCounters SummarizedCounterList
- AttackId AttackId
- AttackProperties AttackProperties
- EndTime AttackTimestamp
- Mitigations MitigationList
- ResourceArn ResourceArn
- StartTime AttackTimestamp
- SubResources SubResourceSummaryList

AttackId

AttackId string

AttackLayer

AttackLayer string (values: NETWORK, APPLICATION)

AttackProperties

AttackProperties array
- items AttackProperty

AttackProperty

AttackProperty object: Details of the described attack.
- AttackLayer AttackLayer
- AttackPropertyIdentifier AttackPropertyIdentifier
- TopContributors TopContributors
- Total Long
- Unit Unit

AttackPropertyIdentifier

AttackPropertyIdentifier string (values: DESTINATION_URL, REFERRER, SOURCE_ASN, SOURCE_COUNTRY, SOURCE_IP_ADDRESS, SOURCE_USER_AGENT)

AttackSummaries

AttackSummaries array
- items AttackSummary

AttackSummary

AttackSummary object: Summarizes all DDoS attacks for a specified time period.
- AttackId String
- AttackVectors AttackVectorDescriptionList
- EndTime AttackTimestamp
- ResourceArn String
- StartTime AttackTimestamp

AttackTimestamp

AttackTimestamp string

AttackVectorDescription

AttackVectorDescription object: Describes the attack.
- VectorType required String

AttackVectorDescriptionList

AttackVectorDescriptionList array
- items AttackVectorDescription

Contributor

Contributor object: A contributor to the attack and their contribution.
- Name String
- Value Long

CreateProtectionRequest

CreateProtectionRequest object
- Name required ProtectionName
- ResourceArn required ResourceArn

CreateProtectionResponse

CreateProtectionResponse object
- ProtectionId ProtectionId

CreateSubscriptionRequest

CreateSubscriptionRequest object

CreateSubscriptionResponse

CreateSubscriptionResponse object

DeleteProtectionRequest

DeleteProtectionRequest object
- ProtectionId required ProtectionId

DeleteProtectionResponse

DeleteProtectionResponse object

DeleteSubscriptionRequest

DeleteSubscriptionRequest object

DeleteSubscriptionResponse

DeleteSubscriptionResponse object

DescribeAttackRequest

DescribeAttackRequest object
- AttackId required AttackId

DescribeAttackResponse

DescribeAttackResponse object
- Attack AttackDetail

DescribeProtectionRequest

DescribeProtectionRequest object
- ProtectionId required ProtectionId

DescribeProtectionResponse

DescribeProtectionResponse object
- Protection Protection

DescribeSubscriptionRequest

DescribeSubscriptionRequest object

DescribeSubscriptionResponse

DescribeSubscriptionResponse object
- Subscription Subscription

Double

Double number

DurationInSeconds

DurationInSeconds integer

GetSubscriptionStateRequest

GetSubscriptionStateRequest object

GetSubscriptionStateResponse

GetSubscriptionStateResponse object
- SubscriptionState required SubscriptionState

Integer

Integer integer

InternalErrorException

InternalErrorException object: Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.
- message errorMessage

InvalidOperationException

InvalidOperationException object: Exception that indicates that the operation would not cause any change to occur.
- message errorMessage

InvalidParameterException

InvalidParameterException object: Exception that indicates that the parameters passed to the API are invalid.
- message errorMessage

InvalidResourceException

InvalidResourceException object: Exception that indicates that the resource is invalid. You might not have access to the resource, or the resource might not exist.
- message errorMessage

LimitNumber

LimitNumber integer

LimitType

LimitType string

LimitsExceededException

LimitsExceededException object: Exception that indicates that the operation would exceed a limit. Type is the type of limit that would be exceeded. Limit is the threshold that would be exceeded.
- Limit LimitNumber
- Type LimitType
- message errorMessage

ListAttacksRequest

ListAttacksRequest object
- EndTime TimeRange
- MaxResults MaxResults
- NextToken Token
- ResourceArns ResourceArnFilterList
- StartTime TimeRange

ListAttacksResponse

ListAttacksResponse object
- AttackSummaries AttackSummaries
- NextToken Token

ListProtectionsRequest

ListProtectionsRequest object
- MaxResults MaxResults
- NextToken Token

ListProtectionsResponse

ListProtectionsResponse object
- NextToken Token
- Protections Protections

LockedSubscriptionException

LockedSubscriptionException object: Exception that indicates that the subscription you are trying to delete has not yet completed the 1-year commitment. You cannot delete this subscription.
- message errorMessage

Long

Long integer

MaxResults

MaxResults integer

Mitigation

Mitigation object: The mitigation applied to a DDoS attack.
- MitigationName String

MitigationList

MitigationList array
- items Mitigation

OptimisticLockException

OptimisticLockException object: Exception that indicates that the protection state has been modified by another client. You can retry the request.
- message errorMessage

Protection

Protection object: An object that represents a resource that is under DDoS protection.
- Id ProtectionId
- Name ProtectionName
- ResourceArn ResourceArn

ProtectionId

ProtectionId string

ProtectionName

ProtectionName string

Protections

Protections array
- items Protection

ResourceAlreadyExistsException

ResourceAlreadyExistsException object: Exception indicating the specified resource already exists.
- message errorMessage

ResourceArn

ResourceArn string

ResourceArnFilterList

ResourceArnFilterList array
- items ResourceArn

ResourceNotFoundException

ResourceNotFoundException object: Exception indicating the specified resource does not exist.
- message errorMessage

String

String string

SubResourceSummary

SubResourceSummary object: The attack information for the specified SubResource.
- AttackVectors SummarizedAttackVectorList
- Counters SummarizedCounterList
- Id String
- Type SubResourceType

SubResourceSummaryList

SubResourceSummaryList array
- items SubResourceSummary

SubResourceType

SubResourceType string (values: IP, URL)

Subscription

Subscription object: Information about the AWS Shield Advanced subscription for an account.
- StartTime Timestamp
- TimeCommitmentInSeconds DurationInSeconds

SubscriptionState

SubscriptionState string (values: ACTIVE, INACTIVE)

SummarizedAttackVector

SummarizedAttackVector object: A summary of information about the attack.
- VectorCounters SummarizedCounterList
- VectorType required String

SummarizedAttackVectorList

SummarizedAttackVectorList array
- items SummarizedAttackVector

SummarizedCounter

SummarizedCounter object: The counter that describes a DDoS attack.
- Average Double
- Max Double
- N Integer
- Name String
- Sum Double
- Unit String