Class: Aws::Shield::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-shield/lib/aws-sdk-shield/client.rb

Overview

An API client for Shield. To construct a client, you need to configure a :region and :credentials.

client = Aws::Shield::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider)

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts.
  • :region (required, String)

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: ""

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1"

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :disable_host_prefix_injection (Boolean) — default: false

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String)

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false

    When set to true, endpoint discovery will be enabled for operations when available.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default

    The log formatter.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the :logger at.

  • :logger (Logger)

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default"

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_backoff (Proc)

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy"

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :simple_json (Boolean) — default: false

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects.

  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String)

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_wire_trace (Boolean) — default: false

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String)

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String)

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



334
335
336
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/client.rb', line 334

def initialize(*args)
  super
end

Instance Method Details

#associate_drt_log_bucket(params = {}) ⇒ Struct

Authorizes the DDoS Response Team (DRT) to access the specified Amazon S3 bucket containing your AWS WAF logs. You can associate up to 10 Amazon S3 buckets with your subscription.

To use the services of the DRT and make an AssociateDRTLogBucket request, you must be subscribed to the Business Support plan or the Enterprise Support plan.

Examples:

Request syntax with placeholder values


resp = client.associate_drt_log_bucket({
  log_bucket: "LogBucket", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :log_bucket (required, String)

    The Amazon S3 bucket that contains your AWS WAF logs.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



368
369
370
371
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/client.rb', line 368

def associate_drt_log_bucket(params = {}, options = {})
  req = build_request(:associate_drt_log_bucket, params)
  req.send_request(options)
end

#associate_drt_role(params = {}) ⇒ Struct

Authorizes the DDoS Response Team (DRT), using the specified role, to access your AWS account to assist with DDoS attack mitigation during potential attacks. This enables the DRT to inspect your AWS WAF configuration and create or update AWS WAF rules and web ACLs.

You can associate only one RoleArn with your subscription. If you submit an AssociateDRTRole request for an account that already has an associated role, the new RoleArn will replace the existing RoleArn.

Prior to making the AssociateDRTRole request, you must attach the AWSShieldDRTAccessPolicy managed policy to the role you will specify in the request. For more information see Attaching and Detaching IAM Policies. The role must also trust the service principal drt.shield.amazonaws.com. For more information, see IAM JSON Policy Elements: Principal.

The DRT will have access only to your AWS WAF and Shield resources. By submitting this request, you authorize the DRT to inspect your AWS WAF and Shield configuration and create and update AWS WAF rules and web ACLs on your behalf. The DRT takes these actions only if explicitly authorized by you.

You must have the iam:PassRole permission to make an AssociateDRTRole request. For more information, see Granting a User Permissions to Pass a Role to an AWS Service.

To use the services of the DRT and make an AssociateDRTRole request, you must be subscribed to the Business Support plan or the Enterprise Support plan.

Examples:

Request syntax with placeholder values


resp = client.associate_drt_role({
  role_arn: "RoleArn", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :role_arn (required, String)

    The Amazon Resource Name (ARN) of the role the DRT will use to access your AWS account.

    Prior to making the AssociateDRTRole request, you must attach the AWSShieldDRTAccessPolicy managed policy to this role. For more information see Attaching and Detaching IAM Policies.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



439
440
441
442
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/client.rb', line 439

def associate_drt_role(params = {}, options = {})
  req = build_request(:associate_drt_role, params)
  req.send_request(options)
end

#associate_health_check(params = {}) ⇒ Struct

Adds health-based detection to the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your AWS resource to improve responsiveness and accuracy in attack detection and mitigation.

You define the health check in Route 53 and then associate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the AWS WAF and AWS Shield Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.associate_health_check({
  protection_id: "ProtectionId", # required
  health_check_arn: "HealthCheckArn", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :protection_id (required, String)

    The unique identifier (ID) for the Protection object to add the health check association to.

  • :health_check_arn (required, String)

    The Amazon Resource Name (ARN) of the health check to associate with the protection.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



480
481
482
483
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/client.rb', line 480

def associate_health_check(params = {}, options = {})
  req = build_request(:associate_health_check, params)
  req.send_request(options)
end

#associate_proactive_engagement_details(params = {}) ⇒ Struct

Initializes proactive engagement and sets the list of contacts for the DDoS Response Team (DRT) to use. You must provide at least one phone number in the emergency contact list.

After you have initialized proactive engagement using this call, to disable or enable proactive engagement, use the calls DisableProactiveEngagement and EnableProactiveEngagement.

This call defines the list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you for escalations to the DRT and to initiate proactive customer support.

The contacts that you provide in the request replace any contacts that were already defined. If you already have contacts defined and want to use them, retrieve the list using DescribeEmergencyContactSettings and then provide it to this call.

Examples:

Request syntax with placeholder values


resp = client.associate_proactive_engagement_details({
  emergency_contact_list: [ # required
    {
      email_address: "EmailAddress", # required
      phone_number: "PhoneNumber",
      contact_notes: "ContactNotes",
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :emergency_contact_list (required, Array<Types::EmergencyContact>)

    A list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you for escalations to the DRT and to initiate proactive customer support.

    To enable proactive engagement, the contact list must include at least one phone number.

    The contacts that you provide here replace any contacts that were already defined. If you already have contacts defined and want to use them, retrieve the list using DescribeEmergencyContactSettings and then provide it here.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



537
538
539
540
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/client.rb', line 537

def associate_proactive_engagement_details(params = {}, options = {})
  req = build_request(:associate_proactive_engagement_details, params)
  req.send_request(options)
end

#create_protection(params = {}) ⇒ Types::CreateProtectionResponse

Enables AWS Shield Advanced for a specific AWS resource. The resource can be an Amazon CloudFront distribution, Elastic Load Balancing load balancer, AWS Global Accelerator accelerator, Elastic IP Address, or an Amazon Route 53 hosted zone.

You can add protection to only a single resource with each CreateProtection request. If you want to add protection to multiple resources at once, use the AWS WAF console. For more information see Getting Started with AWS Shield Advanced and Add AWS Shield Advanced Protection to more AWS Resources.

Examples:

Request syntax with placeholder values


resp = client.create_protection({
  name: "ProtectionName", # required
  resource_arn: "ResourceArn", # required
})

Response structure


resp.protection_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :name (required, String)

    Friendly name for the Protection you are creating.

  • :resource_arn (required, String)

    The ARN (Amazon Resource Name) of the resource to be protected.

    The ARN should be in one of the following formats:

    • For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id

    • For an Elastic Load Balancer (Classic Load Balancer): arn:aws:elasticloadbalancing:region:account-id:loadbalancer/load-balancer-name

    • For an AWS CloudFront distribution: arn:aws:cloudfront::account-id:distribution/distribution-id

    • For an AWS Global Accelerator accelerator: arn:aws:globalaccelerator::account-id:accelerator/accelerator-id

    • For Amazon Route 53: arn:aws:route53:::hostedzone/hosted-zone-id

    • For an Elastic IP address: arn:aws:ec2:region:account-id:eip-allocation/allocation-id

Returns:

See Also:



605
606
607
608
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/client.rb', line 605

def create_protection(params = {}, options = {})
  req = build_request(:create_protection, params)
  req.send_request(options)
end

#create_subscription(params = {}) ⇒ Struct

Activates AWS Shield Advanced for an account.

When you initally create a subscription, your subscription is set to be automatically renewed at the end of the existing subscription period. You can change this by submitting an UpdateSubscription request.

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Returns:

  • (Struct)

    Returns an empty response.

See Also:



623
624
625
626
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/client.rb', line 623

def create_subscription(params = {}, options = {})
  req = build_request(:create_subscription, params)
  req.send_request(options)
end

#delete_protection(params = {}) ⇒ Struct

Deletes an AWS Shield Advanced Protection.

Examples:

Request syntax with placeholder values


resp = client.delete_protection({
  protection_id: "ProtectionId", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :protection_id (required, String)

    The unique identifier (ID) for the Protection object to be deleted.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



645
646
647
648
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/client.rb', line 645

def delete_protection(params = {}, options = {})
  req = build_request(:delete_protection, params)
  req.send_request(options)
end

#delete_subscription(params = {}) ⇒ Struct

Removes AWS Shield Advanced from an account. AWS Shield Advanced requires a 1-year subscription commitment. You cannot delete a subscription prior to the completion of that commitment.

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Returns:

  • (Struct)

    Returns an empty response.

See Also:



660
661
662
663
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/client.rb', line 660

def delete_subscription(params = {}, options = {})
  req = build_request(:delete_subscription, params)
  req.send_request(options)
end

#describe_attack(params = {}) ⇒ Types::DescribeAttackResponse

Describes the details of a DDoS attack.

Examples:

Request syntax with placeholder values


resp = client.describe_attack({
  attack_id: "AttackId", # required
})

Response structure


resp.attack.attack_id #=> String
resp.attack.resource_arn #=> String
resp.attack.sub_resources #=> Array
resp.attack.sub_resources[0].type #=> String, one of "IP", "URL"
resp.attack.sub_resources[0].id #=> String
resp.attack.sub_resources[0].attack_vectors #=> Array
resp.attack.sub_resources[0].attack_vectors[0].vector_type #=> String
resp.attack.sub_resources[0].attack_vectors[0].vector_counters #=> Array
resp.attack.sub_resources[0].attack_vectors[0].vector_counters[0].name #=> String
resp.attack.sub_resources[0].attack_vectors[0].vector_counters[0].max #=> Float
resp.attack.sub_resources[0].attack_vectors[0].vector_counters[0].average #=> Float
resp.attack.sub_resources[0].attack_vectors[0].vector_counters[0].sum #=> Float
resp.attack.sub_resources[0].attack_vectors[0].vector_counters[0].n #=> Integer
resp.attack.sub_resources[0].attack_vectors[0].vector_counters[0].unit #=> String
resp.attack.sub_resources[0].counters #=> Array
resp.attack.sub_resources[0].counters[0].name #=> String
resp.attack.sub_resources[0].counters[0].max #=> Float
resp.attack.sub_resources[0].counters[0].average #=> Float
resp.attack.sub_resources[0].counters[0].sum #=> Float
resp.attack.sub_resources[0].counters[0].n #=> Integer
resp.attack.sub_resources[0].counters[0].unit #=> String
resp.attack.start_time #=> Time
resp.attack.end_time #=> Time
resp.attack.attack_counters #=> Array
resp.attack.attack_counters[0].name #=> String
resp.attack.attack_counters[0].max #=> Float
resp.attack.attack_counters[0].average #=> Float
resp.attack.attack_counters[0].sum #=> Float
resp.attack.attack_counters[0].n #=> Integer
resp.attack.attack_counters[0].unit #=> String
resp.attack.attack_properties #=> Array
resp.attack.attack_properties[0].attack_layer #=> String, one of "NETWORK", "APPLICATION"
resp.attack.attack_properties[0].attack_property_identifier #=> String, one of "DESTINATION_URL", "REFERRER", "SOURCE_ASN", "SOURCE_COUNTRY", "SOURCE_IP_ADDRESS", "SOURCE_USER_AGENT", "WORDPRESS_PINGBACK_REFLECTOR", "WORDPRESS_PINGBACK_SOURCE"
resp.attack.attack_properties[0].top_contributors #=> Array
resp.attack.attack_properties[0].top_contributors[0].name #=> String
resp.attack.attack_properties[0].top_contributors[0].value #=> Integer
resp.attack.attack_properties[0].unit #=> String, one of "BITS", "BYTES", "PACKETS", "REQUESTS"
resp.attack.attack_properties[0].total #=> Integer
resp.attack.mitigations #=> Array
resp.attack.mitigations[0].mitigation_name #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :attack_id (required, String)

    The unique identifier (ID) for the attack that to be described.

Returns:

See Also:



727
728
729
730
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/client.rb', line 727

def describe_attack(params = {}, options = {})
  req = build_request(:describe_attack, params)
  req.send_request(options)
end

#describe_drt_access(params = {}) ⇒ Types::DescribeDRTAccessResponse

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.

Examples:

Response structure


resp.role_arn #=> String
resp.log_bucket_list #=> Array
resp.log_bucket_list[0] #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Returns:

See Also:



751
752
753
754
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/client.rb', line 751

def describe_drt_access(params = {}, options = {})
  req = build_request(:describe_drt_access, params)
  req.send_request(options)
end

#describe_emergency_contact_settings(params = {}) ⇒ Types::DescribeEmergencyContactSettingsResponse

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.

Examples:

Response structure


resp.emergency_contact_list #=> Array
resp.emergency_contact_list[0].email_address #=> String
resp.emergency_contact_list[0].phone_number #=> String
resp.emergency_contact_list[0].contact_notes #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Returns:

See Also:



776
777
778
779
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/client.rb', line 776

def describe_emergency_contact_settings(params = {}, options = {})
  req = build_request(:describe_emergency_contact_settings, params)
  req.send_request(options)
end

#describe_protection(params = {}) ⇒ Types::DescribeProtectionResponse

Lists the details of a Protection object.

Examples:

Request syntax with placeholder values


resp = client.describe_protection({
  protection_id: "ProtectionId",
  resource_arn: "ResourceArn",
})

Response structure


resp.protection.id #=> String
resp.protection.name #=> String
resp.protection.resource_arn #=> String
resp.protection.health_check_ids #=> Array
resp.protection.health_check_ids[0] #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :protection_id (String)

    The unique identifier (ID) for the Protection object that is described. When submitting the DescribeProtection request you must provide either the ResourceArn or the ProtectionID, but not both.

  • :resource_arn (String)

    The ARN (Amazon Resource Name) of the AWS resource for the Protection object that is described. When submitting the DescribeProtection request you must provide either the ResourceArn or the ProtectionID, but not both.

Returns:

See Also:



817
818
819
820
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/client.rb', line 817

def describe_protection(params = {}, options = {})
  req = build_request(:describe_protection, params)
  req.send_request(options)
end

#describe_subscription(params = {}) ⇒ Types::DescribeSubscriptionResponse

Provides details about the AWS Shield Advanced subscription for an account.

Examples:

Response structure


resp.subscription.start_time #=> Time
resp.subscription.end_time #=> Time
resp.subscription.time_commitment_in_seconds #=> Integer
resp.subscription.auto_renew #=> String, one of "ENABLED", "DISABLED"
resp.subscription.limits #=> Array
resp.subscription.limits[0].type #=> String
resp.subscription.limits[0].max #=> Integer
resp.subscription.proactive_engagement_status #=> String, one of "ENABLED", "DISABLED", "PENDING"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Returns:

See Also:



844
845
846
847
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/client.rb', line 844

def describe_subscription(params = {}, options = {})
  req = build_request(:describe_subscription, params)
  req.send_request(options)
end

#disable_proactive_engagement(params = {}) ⇒ Struct

Removes authorization from the DDoS Response Team (DRT) to notify contacts about escalations to the DRT and to initiate proactive customer support.

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Returns:

  • (Struct)

    Returns an empty response.

See Also:



859
860
861
862
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/client.rb', line 859

def disable_proactive_engagement(params = {}, options = {})
  req = build_request(:disable_proactive_engagement, params)
  req.send_request(options)
end

#disassociate_drt_log_bucket(params = {}) ⇒ Struct

Removes the DDoS Response Team's (DRT) access to the specified Amazon S3 bucket containing your AWS WAF logs.

To make a DisassociateDRTLogBucket request, you must be subscribed to the Business Support plan or the Enterprise Support plan. However, if you are not subscribed to one of these support plans, but had been previously and had granted the DRT access to your account, you can submit a DisassociateDRTLogBucket request to remove this access.

Examples:

Request syntax with placeholder values


resp = client.disassociate_drt_log_bucket({
  log_bucket: "LogBucket", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :log_bucket (required, String)

    The Amazon S3 bucket that contains your AWS WAF logs.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



894
895
896
897
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/client.rb', line 894

def disassociate_drt_log_bucket(params = {}, options = {})
  req = build_request(:disassociate_drt_log_bucket, params)
  req.send_request(options)
end

#disassociate_drt_role(params = {}) ⇒ Struct

Removes the DDoS Response Team's (DRT) access to your AWS account.

To make a DisassociateDRTRole request, you must be subscribed to the Business Support plan or the Enterprise Support plan. However, if you are not subscribed to one of these support plans, but had been previously and had granted the DRT access to your account, you can submit a DisassociateDRTRole request to remove this access.

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Returns:

  • (Struct)

    Returns an empty response.

See Also:



918
919
920
921
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/client.rb', line 918

def disassociate_drt_role(params = {}, options = {})
  req = build_request(:disassociate_drt_role, params)
  req.send_request(options)
end

#disassociate_health_check(params = {}) ⇒ Struct

Removes health-based detection from the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your AWS resource to improve responsiveness and accuracy in attack detection and mitigation.

You define the health check in Route 53 and then associate or disassociate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the AWS WAF and AWS Shield Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.disassociate_health_check({
  protection_id: "ProtectionId", # required
  health_check_arn: "HealthCheckArn", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :protection_id (required, String)

    The unique identifier (ID) for the Protection object to remove the health check association from.

  • :health_check_arn (required, String)

    The Amazon Resource Name (ARN) of the health check that is associated with the protection.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



959
960
961
962
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/client.rb', line 959

def disassociate_health_check(params = {}, options = {})
  req = build_request(:disassociate_health_check, params)
  req.send_request(options)
end

#enable_proactive_engagement(params = {}) ⇒ Struct

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.

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Returns:

  • (Struct)

    Returns an empty response.

See Also:



974
975
976
977
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/client.rb', line 974

def enable_proactive_engagement(params = {}, options = {})
  req = build_request(:enable_proactive_engagement, params)
  req.send_request(options)
end

#get_subscription_state(params = {}) ⇒ Types::GetSubscriptionStateResponse

Returns the SubscriptionState, either Active or Inactive.

Examples:

Response structure


resp.subscription_state #=> String, one of "ACTIVE", "INACTIVE"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Returns:

See Also:



993
994
995
996
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/client.rb', line 993

def get_subscription_state(params = {}, options = {})
  req = build_request(:get_subscription_state, params)
  req.send_request(options)
end

#list_attacks(params = {}) ⇒ Types::ListAttacksResponse

Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_attacks({
  resource_arns: ["ResourceArn"],
  start_time: {
    from_inclusive: Time.now,
    to_exclusive: Time.now,
  },
  end_time: {
    from_inclusive: Time.now,
    to_exclusive: Time.now,
  },
  next_token: "Token",
  max_results: 1,
})

Response structure


resp.attack_summaries #=> Array
resp.attack_summaries[0].attack_id #=> String
resp.attack_summaries[0].resource_arn #=> String
resp.attack_summaries[0].start_time #=> Time
resp.attack_summaries[0].end_time #=> Time
resp.attack_summaries[0].attack_vectors #=> Array
resp.attack_summaries[0].attack_vectors[0].vector_type #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arns (Array<String>)

    The ARN (Amazon Resource Name) of the resource that was attacked. If this is left blank, all applicable resources for this account will be included.

  • :start_time (Types::TimeRange)

    The start of the time period for the attacks. This is a timestamp type. The sample request above indicates a number type because the default used by WAF is Unix time in seconds. However any valid timestamp format is allowed.

  • :end_time (Types::TimeRange)

    The end of the time period for the attacks. This is a timestamp type. The sample request above indicates a number type because the default used by WAF is Unix time in seconds. However any valid timestamp format is allowed.

  • :next_token (String)

    The ListAttacksRequest.NextMarker value from a previous call to ListAttacksRequest. Pass null if this is the first call.

  • :max_results (Integer)

    The maximum number of AttackSummary objects to be returned. If this is left blank, the first 20 results will be returned.

    This is a maximum value; it is possible that AWS WAF will return the results in smaller batches. That is, the number of AttackSummary objects returned could be less than MaxResults, even if there are still more AttackSummary objects yet to return. If there are more AttackSummary objects to return, AWS WAF will always also return a NextToken.

Returns:

See Also:



1079
1080
1081
1082
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/client.rb', line 1079

def list_attacks(params = {}, options = {})
  req = build_request(:list_attacks, params)
  req.send_request(options)
end

#list_protections(params = {}) ⇒ Types::ListProtectionsResponse

Lists all Protection objects for the account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_protections({
  next_token: "Token",
  max_results: 1,
})

Response structure


resp.protections #=> Array
resp.protections[0].id #=> String
resp.protections[0].name #=> String
resp.protections[0].resource_arn #=> String
resp.protections[0].health_check_ids #=> Array
resp.protections[0].health_check_ids[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :next_token (String)

    The ListProtectionsRequest.NextToken value from a previous call to ListProtections. Pass null if this is the first call.

  • :max_results (Integer)

    The maximum number of Protection objects to be returned. If this is left blank the first 20 results will be returned.

    This is a maximum value; it is possible that AWS WAF will return the results in smaller batches. That is, the number of Protection objects returned could be less than MaxResults, even if there are still more Protection objects yet to return. If there are more Protection objects to return, AWS WAF will always also return a NextToken.

Returns:

See Also:



1128
1129
1130
1131
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/client.rb', line 1128

def list_protections(params = {}, options = {})
  req = build_request(:list_protections, params)
  req.send_request(options)
end

#update_emergency_contact_settings(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.update_emergency_contact_settings({
  emergency_contact_list: [
    {
      email_address: "EmailAddress", # required
      phone_number: "PhoneNumber",
      contact_notes: "ContactNotes",
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :emergency_contact_list (Array<Types::EmergencyContact>)

    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.

    If you have proactive engagement enabled, the contact list must include at least one phone number.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1165
1166
1167
1168
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/client.rb', line 1165

def update_emergency_contact_settings(params = {}, options = {})
  req = build_request(:update_emergency_contact_settings, params)
  req.send_request(options)
end

#update_subscription(params = {}) ⇒ Struct

Updates the details of an existing subscription. Only enter values for parameters you want to change. Empty parameters are not updated.

Examples:

Request syntax with placeholder values


resp = client.update_subscription({
  auto_renew: "ENABLED", # accepts ENABLED, DISABLED
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :auto_renew (String)

    When you initally create a subscription, AutoRenew is set to ENABLED. If ENABLED, the subscription will be automatically renewed at the end of the existing subscription period. You can change this by submitting an UpdateSubscription request. If the UpdateSubscription request does not included a value for AutoRenew, the existing value for AutoRenew remains unchanged.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1193
1194
1195
1196
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/client.rb', line 1193

def update_subscription(params = {}, options = {})
  req = build_request(:update_subscription, params)
  req.send_request(options)
end