paws.security.identity (version 0.1.12)

shield: AWS Shield

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.

Usage

shield(config = list())

Value

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.

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Service syntax

svc <- shield(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

associate_drt_log_bucket	Authorizes the DDoS Response Team (DRT) to access the specified Amazon S3 bucket containing your AWS WAF logs
associate_drt_role	Authorizes the DDoS Response Team (DRT), using the specified role, to access your AWS 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 DDoS Response Team (DRT) to use
create_protection	Enables AWS Shield Advanced for a specific AWS resource
create_protection_group	Creates a grouping of protected resources so they can be handled as a collective
create_subscription	Activates AWS Shield Advanced for an account
delete_protection	Deletes an AWS Shield Advanced Protection
delete_protection_group	Removes the specified protection group
delete_subscription	Removes AWS 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 AWS 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 DDoS Response Team (DRT) to access your AWS account while assisting with attack mitigation
describe_emergency_contact_settings	A list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you if you have proactive engagement enabled, for escalations to the DRT 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 AWS Shield Advanced subscription for an account
disable_proactive_engagement	Removes authorization from the DDoS Response Team (DRT) to notify contacts about escalations to the DRT and to initiate proactive customer support
disassociate_drt_log_bucket	Removes the DDoS Response Team's (DRT) access to the specified Amazon S3 bucket containing your AWS WAF logs
disassociate_drt_role	Removes the DDoS Response Team's (DRT) access to your AWS account
disassociate_health_check	Removes health-based detection from the Shield Advanced protection for a resource
enable_proactive_engagement	Authorizes the DDoS Response Team (DRT) to use email and phone to notify contacts about escalations to the DRT 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 the ProtectionGroup objects for the account
list_protections	Lists all Protection objects for the account
list_resources_in_protection_group	Retrieves the resources that are included in the protection group
update_emergency_contact_settings	Updates the details of the list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you if you have proactive engagement enabled, for escalations to the DRT and to initiate proactive customer support
update_protection_group	Updates an existing protection group
update_subscription	Updates the details of an existing subscription

Examples

if (FALSE) {
svc <- shield()
svc$associate_drt_log_bucket(
  Foo = 123
)
}