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.
shield(config = list(), credentials = list(), endpoint = NULL, region = NULL)A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Optional configuration of credentials, endpoint, and/or region.
credentials:
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
Optional credentials shorthand for the config parameter
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
Optional shorthand for complete URL to use for the constructed client.
Optional shorthand for AWS Region used in instantiating the client.
svc <- shield(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
| associate_drt_log_bucket | Authorizes the Shield Response Team (SRT) to access the specified Amazon S3 bucket containing log data such as Application Load Balancer access logs, CloudFront logs, or logs from third party sources |
| associate_drt_role | Authorizes the Shield Response Team (SRT) using the specified role, to access your Amazon Web Services account to assist with DDoS attack mitigation during potential attacks |
| associate_health_check | Adds health-based detection to the Shield Advanced protection for a resource |
| associate_proactive_engagement_details | Initializes proactive engagement and sets the list of contacts for the Shield Response Team (SRT) to use |
| create_protection | Enables Shield Advanced for a specific Amazon Web Services resource |
| create_protection_group | Creates a grouping of protected resources so they can be handled as a collective |
| create_subscription | Activates Shield Advanced for an account |
| delete_protection | Deletes an Shield Advanced Protection |
| delete_protection_group | Removes the specified protection group |
| delete_subscription | Removes Shield Advanced from an account |
| describe_attack | Describes the details of a DDoS attack |
| describe_attack_statistics | Provides 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 whether you've defined Shield protections for them |
| describe_drt_access | Returns 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 with attack mitigation |
| describe_emergency_contact_settings | 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 |
| describe_protection | Lists the details of a Protection object |
| describe_protection_group | Returns the specification for the specified protection group |
| describe_subscription | Provides details about the Shield Advanced subscription for an account |
| disable_application_layer_automatic_response | Disable the Shield Advanced automatic application layer DDoS mitigation feature for the protected resource |
| disable_proactive_engagement | Removes authorization from the Shield Response Team (SRT) to notify contacts about escalations to the SRT and to initiate proactive customer support |
| disassociate_drt_log_bucket | Removes the Shield Response Team's (SRT) access to the specified Amazon S3 bucket containing the logs that you shared previously |
| disassociate_drt_role | Removes the Shield Response Team's (SRT) access to your Amazon Web Services account |
| disassociate_health_check | Removes health-based detection from the Shield Advanced protection for a resource |
| enable_application_layer_automatic_response | Enable the Shield Advanced automatic application layer DDoS mitigation for the protected resource |
| enable_proactive_engagement | Authorizes the Shield Response Team (SRT) to use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support |
| get_subscription_state | Returns the SubscriptionState, either Active or Inactive |
| list_attacks | Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period |
| list_protection_groups | Retrieves ProtectionGroup objects for the account |
| list_protections | Retrieves Protection objects for the account |
| list_resources_in_protection_group | Retrieves the resources that are included in the protection group |
| list_tags_for_resource | Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in Shield |
| tag_resource | Adds or updates tags for a resource in Shield |
| untag_resource | Removes tags from a resource in Shield |
| update_application_layer_automatic_response | Updates an existing Shield Advanced automatic application layer DDoS mitigation configuration for the specified resource |
| update_emergency_contact_settings | Updates 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 engagement enabled, for escalations to the SRT and to initiate proactive customer support |
| update_protection_group | Updates an existing protection group |
| update_subscription | Updates the details of an existing subscription |
if (FALSE) {
svc <- shield()
svc$associate_drt_log_bucket(
Foo = 123
)
}
Run the code above in your browser using DataLab