Amazon Web Services, Inc.

AWS Shield

Shield Advanced This is the Shield Advanced API Reference . This guide is for developers who need detailed information about the Shield Advanced API actions,…

Identity & security#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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 .

Endpoints 36

  • POSTAssociate dRT log bucket/#X-Amz-Target=AWSShield_20160616.AssociateDRTLogBucketAuthorizes the Shield Response Team (SRT) to access the specified Amazon S3 bucket containing log data such as Application Load Balancer access logs,…
  • POSTAssociate dRT role/#X-Amz-Target=AWSShield_20160616.AssociateDRTRoleAuthorizes the Shield Response Team (SRT) using the specified role, to access your Amazon Web Services account to assist with DDoS attack mitigation during…
  • POSTAssociate health check/#X-Amz-Target=AWSShield_20160616.AssociateHealthCheckAdds health-based detection to the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your Amazon Web…
  • POSTAssociate proactive engagement details/#X-Amz-Target=AWSShield_20160616.AssociateProactiveEngagementDetailsInitializes proactive engagement and sets the list of contacts for the Shield Response Team (SRT) to use. You must provide at least one phone number in the…
  • POSTCreate protection/#X-Amz-Target=AWSShield_20160616.CreateProtectionEnables Shield Advanced for a specific Amazon Web Services resource. The resource can be an Amazon CloudFront distribution, Amazon Route 53 hosted zone,…
  • POSTCreate protection group/#X-Amz-Target=AWSShield_20160616.CreateProtectionGroupCreates a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false…
  • POSTCreate subscription/#X-Amz-Target=AWSShield_20160616.CreateSubscriptionActivates Shield Advanced for an account. For accounts that are members of an Organizations organization, Shield Advanced subscriptions are billed against the…
  • POSTDelete protection/#X-Amz-Target=AWSShield_20160616.DeleteProtectionDeletes an Shield Advanced Protection .
  • POSTDelete protection group/#X-Amz-Target=AWSShield_20160616.DeleteProtectionGroupRemoves the specified protection group.
  • POSTDelete subscription/#X-Amz-Target=AWSShield_20160616.DeleteSubscriptionDeprecated. Removes Shield Advanced from an account. Shield Advanced requires a 1-year subscription commitment. You cannot delete a subscription prior to the…
  • POSTDescribe attack/#X-Amz-Target=AWSShield_20160616.DescribeAttackDescribes the details of a DDoS attack.
  • POSTDescribe attack statistics/#X-Amz-Target=AWSShield_20160616.DescribeAttackStatisticsProvides information about the number and type of attacks Shield has detected in the last year for all resources that belong to your account, regardless of…
  • POSTDescribe dRT access/#X-Amz-Target=AWSShield_20160616.DescribeDRTAccessReturns the current role and list of Amazon S3 log buckets used by the Shield Response Team (SRT) to access your Amazon Web Services account while assisting…
  • POSTDescribe emergency contact settings/#X-Amz-Target=AWSShield_20160616.DescribeEmergencyContactSettingsA 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…
  • POSTDescribe protection/#X-Amz-Target=AWSShield_20160616.DescribeProtectionLists the details of a Protection object.
  • POSTDescribe protection group/#X-Amz-Target=AWSShield_20160616.DescribeProtectionGroupReturns the specification for the specified protection group.
  • POSTDescribe subscription/#X-Amz-Target=AWSShield_20160616.DescribeSubscriptionProvides details about the Shield Advanced subscription for an account.
  • POSTDisable application layer automatic response/#X-Amz-Target=AWSShield_20160616.DisableApplicationLayerAutomaticResponseDisable the Shield Advanced automatic application layer DDoS mitigation feature for the protected resource. This stops Shield Advanced from creating,…
  • POSTDisable proactive engagement/#X-Amz-Target=AWSShield_20160616.DisableProactiveEngagementRemoves authorization from the Shield Response Team (SRT) to notify contacts about escalations to the SRT and to initiate proactive customer support.
  • POSTDisassociate dRT log bucket/#X-Amz-Target=AWSShield_20160616.DisassociateDRTLogBucketRemoves the Shield Response Team's (SRT) access to the specified Amazon S3 bucket containing the logs that you shared previously.
  • POSTDisassociate dRT role/#X-Amz-Target=AWSShield_20160616.DisassociateDRTRoleRemoves the Shield Response Team's (SRT) access to your Amazon Web Services account.
  • POSTDisassociate health check/#X-Amz-Target=AWSShield_20160616.DisassociateHealthCheckRemoves health-based detection from the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your Amazon Web…
  • POSTEnable application layer automatic response/#X-Amz-Target=AWSShield_20160616.EnableApplicationLayerAutomaticResponseEnable the Shield Advanced automatic application layer DDoS mitigation for the protected resource. This feature is available for Amazon CloudFront…
  • POSTEnable proactive engagement/#X-Amz-Target=AWSShield_20160616.EnableProactiveEngagementAuthorizes the Shield Response Team (SRT) to use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.
  • POSTGet subscription state/#X-Amz-Target=AWSShield_20160616.GetSubscriptionStateReturns the SubscriptionState , either Active or Inactive .
  • POSTList attacks/#X-Amz-Target=AWSShield_20160616.ListAttacksReturns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
  • POSTList protection groups/#X-Amz-Target=AWSShield_20160616.ListProtectionGroupsRetrieves ProtectionGroup objects for the account. You can retrieve all protection groups or you can provide filtering criteria and retrieve just the subset…
  • POSTList protections/#X-Amz-Target=AWSShield_20160616.ListProtectionsRetrieves Protection objects for the account. You can retrieve all protections or you can provide filtering criteria and retrieve just the subset of…
  • POSTList resources in protection group/#X-Amz-Target=AWSShield_20160616.ListResourcesInProtectionGroupRetrieves the resources that are included in the protection group.
  • POSTList tags for resource/#X-Amz-Target=AWSShield_20160616.ListTagsForResourceGets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in Shield.
  • POSTTag resource/#X-Amz-Target=AWSShield_20160616.TagResourceAdds or updates tags for a resource in Shield.
  • POSTUntag resource/#X-Amz-Target=AWSShield_20160616.UntagResourceRemoves tags from a resource in Shield.
  • POSTUpdate application layer automatic response/#X-Amz-Target=AWSShield_20160616.UpdateApplicationLayerAutomaticResponseUpdates an existing Shield Advanced automatic application layer DDoS mitigation configuration for the specified resource.
  • POSTUpdate emergency contact settings/#X-Amz-Target=AWSShield_20160616.UpdateEmergencyContactSettingsUpdates the details of the list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive…
  • POSTUpdate protection group/#X-Amz-Target=AWSShield_20160616.UpdateProtectionGroupUpdates an existing protection group. A protection group is a grouping of protected resources so they can be handled as a collective. This resource grouping…
  • POSTUpdate subscription/#X-Amz-Target=AWSShield_20160616.UpdateSubscriptionUpdates the details of an existing subscription. Only enter values for parameters you want to change. Empty parameters are not updated. For accounts that are…

API details

Base URL
https://shield.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
36 operations on 36 pathsPOST 36
1 marked deprecated
Description format
AWS Smithy model, API version 2016-06-02

How to test the AWS Shield in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Shield collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Associate dRT log bucket” (POST /#X-Amz-Target=AWSShield_20160616.AssociateDRTLogBucket), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS Shield?

Shield Advanced This is the Shield Advanced API Reference . This guide is for developers who need detailed information about the Shield Advanced API actions,… It is listed under Identity & security and has 36 endpoints.

Who publishes the AWS Shield?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS Shield?

Requests go to https://shield.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS Shield?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS Shield have?

36 operations on 36 paths (36 POST).

Is forking the AWS Shield free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.