@aws-sdk/client-shield

Description

AWS SDK for JavaScript Shield Client for Node.js, Browser and React Native.

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.

Installing

To install this package, simply type add or install @aws-sdk/client-shield
using your favorite package manager:
- npm install @aws-sdk/client-shield
- yarn add @aws-sdk/client-shield
- pnpm add @aws-sdk/client-shield

Getting Started

$3

The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the ShieldClient and
the commands you need, for example ListAttacksCommand:

``js
// ES5 example
const { ShieldClient, ListAttacksCommand } = require("@aws-sdk/client-shield");
`

`ts
// ES6+ example
import { ShieldClient, ListAttacksCommand } from "@aws-sdk/client-shield";
`

$3

To send a request, you:

- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call send operation on client with command object as input.
- If you are using a custom http handler, you may call destroy() to close open connections.

`js
// a client can be shared by different commands.
const client = new ShieldClient({ region: "REGION" });

const params = { /* input parameters / };
const command = new ListAttacksCommand(params);
`

#### Async/await

We recommend using await
operator to wait for the promise returned by send operation as follows:

`js
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
`

Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.

#### Promises

You can also use Promise chaining
to execute send operation.

`js
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
`

Promises can also be called using .catch() and .finally() as follows:

`js
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
`

#### Callbacks

We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.

`js
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
`

#### v2 compatible style

The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript

`ts
import * as AWS from "@aws-sdk/client-shield";
const client = new AWS.Shield({ region: "REGION" });

// async/await.
try {
const data = await client.listAttacks(params);
// process data.
} catch (error) {
// error handling.
}

// Promises.
client
.listAttacks(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});

// callbacks.
client.listAttacks(params, (err, data) => {
// process err and data.
});
`

$3

When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).

`js
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
`

Getting Help

Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-shield` package is updated.
To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.

Client Commands (Operations List)

AssociateDRTLogBucket

Command API Reference / Input / Output

AssociateDRTRole

Command API Reference / Input / Output

AssociateHealthCheck

Command API Reference / Input / Output

AssociateProactiveEngagementDetails

Command API Reference / Input / Output

CreateProtection

Command API Reference / Input / Output

CreateProtectionGroup

Command API Reference / Input / Output

CreateSubscription

Command API Reference / Input / Output

DeleteProtection

Command API Reference / Input / Output

DeleteProtectionGroup

Command API Reference / Input / Output

DeleteSubscription

Command API Reference / Input / Output

DescribeAttack

Command API Reference / Input / Output

DescribeAttackStatistics

Command API Reference / Input / Output

DescribeDRTAccess

Command API Reference / Input / Output

DescribeEmergencyContactSettings

Command API Reference / Input / Output

DescribeProtection

Command API Reference / Input / Output

DescribeProtectionGroup

Command API Reference / Input / Output

DescribeSubscription

Command API Reference / Input / Output

DisableApplicationLayerAutomaticResponse

Command API Reference / Input / Output

DisableProactiveEngagement

Command API Reference / Input / Output

DisassociateDRTLogBucket

Command API Reference / Input / Output

DisassociateDRTRole

Command API Reference / Input / Output

DisassociateHealthCheck

Command API Reference / Input / Output

EnableApplicationLayerAutomaticResponse

Command API Reference / Input / Output

EnableProactiveEngagement

Command API Reference / Input / Output

GetSubscriptionState

Command API Reference / Input / Output

ListAttacks

Command API Reference / Input / Output

ListProtectionGroups

Command API Reference / Input / Output

ListProtections

Command API Reference / Input / Output

ListResourcesInProtectionGroup

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateApplicationLayerAutomaticResponse

Command API Reference / Input / Output

UpdateEmergencyContactSettings

Command API Reference / Input / Output

UpdateProtectionGroup

Command API Reference / Input / Output

UpdateSubscription

Command API Reference / Input / Output