Class: Aws::Shield::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
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](/sdk-for-ruby/v3/developer-guide/setup-config.html).

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

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

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`

    • The ‘:access_key_id`, `:secret_access_key`, and `:session_token` options.

    • ENV, ENV

    • ‘~/.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. Instance profile credential fetching can be disabled by setting ENV to true.

  • :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:

  • :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.

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

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :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 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.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/<sdk_ua_app_id>. It should have a maximum length of 50.

  • :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.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true —

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

  • :endpoint_provider (Aws::Shield::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::Shield::EndpointParameters`

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘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 (Float) — 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.

  • :ssl_timeout (Float) — default: nil —

    Sets the SSL timeout in seconds.

  • :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.



380
381
382
 
# File 'lib/aws-sdk-shield/client.rb', line 380

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1929
1930
1931
 
# File 'lib/aws-sdk-shield/client.rb', line 1929

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1932
1933
1934
 
# File 'lib/aws-sdk-shield/client.rb', line 1932

def errors_module
  Errors
end

Instance Method Details

#associate_drt_log_bucket(params = {}) ⇒ Struct

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. You can associate up to 10 Amazon S3 buckets with your subscription.

To use the services of the SRT and make an ‘AssociateDRTLogBucket` request, you must be subscribed to the [Business Support plan] or the [Enterprise Support plan].

[1]: aws.amazon.com/premiumsupport/business-support/ [2]: aws.amazon.com/premiumsupport/enterprise-support/

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 the logs that you want to share.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



415
416
417
418
 
# File 'lib/aws-sdk-shield/client.rb', line 415

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 Shield Response Team (SRT) using the specified role, to access your Amazon Web Services account to assist with DDoS attack mitigation during potential attacks. This enables the SRT to inspect your WAF configuration and create or update 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 that you’ll specify in the request. You can access this policy in the IAM console at [AWSShieldDRTAccessPolicy]. For more information see [Adding and removing IAM identity permissions]. The role must also trust the service principal ‘drt.shield.amazonaws.com`. For more information, see [IAM JSON policy elements: Principal].

The SRT will have access only to your WAF and Shield resources. By submitting this request, you authorize the SRT to inspect your WAF and Shield configuration and create and update WAF rules and web ACLs on your behalf. The SRT 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 Amazon Web Services service].

To use the services of the SRT and make an ‘AssociateDRTRole` request, you must be subscribed to the [Business Support plan] or the [Enterprise Support plan].

[1]: console.aws.amazon.com/iam/home?#/policies/arn:aws:iam::aws:policy/service-role/AWSShieldDRTAccessPolicy [2]: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_manage-attach-detach.html [3]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html [4]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html [5]: aws.amazon.com/premiumsupport/business-support/ [6]: aws.amazon.com/premiumsupport/enterprise-support/

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



486
487
488
489
 
# File 'lib/aws-sdk-shield/client.rb', line 486

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 Amazon Web Services resource to improve responsiveness and accuracy in attack detection and response.

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 *WAF Developer Guide*.

[1]: docs.aws.amazon.com/waf/latest/developerguide/ddos-overview.html#ddos-advanced-health-check-option

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:



525
526
527
528
 
# File 'lib/aws-sdk-shield/client.rb', line 525

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 Shield Response Team (SRT) 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`.

<note markdown=“1”> This call defines the list of email addresses and phone numbers that the SRT can use to contact you for escalations to the SRT 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.

</note>

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 Shield Response Team (SRT) can use to contact you for escalations to the SRT and to initiate proactive customer support.

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

    <note markdown=“1”> 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.

    </note>

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



582
583
584
585
 
# File 'lib/aws-sdk-shield/client.rb', line 582

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

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

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


1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
 
# File 'lib/aws-sdk-shield/client.rb', line 1907

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config)
  context[:gem_name] = 'aws-sdk-shield'
  context[:gem_version] = '1.53.0'
  Seahorse::Client::Request.new(handlers, context)
end

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

Enables Shield Advanced for a specific Amazon Web Services resource. The resource can be an Amazon CloudFront distribution, Amazon Route 53 hosted zone, Global Accelerator standard accelerator, Elastic IP Address, Application Load Balancer, or a Classic Load Balancer. You can protect Amazon EC2 instances and Network Load Balancers by association with protected Amazon EC2 Elastic IP addresses.

You can add protection to only a single resource with each ‘CreateProtection` request. You can add protection to multiple resources at once through the Shield Advanced console at [console.aws.amazon.com/wafv2/shieldv2#/][1]. For more information see [Getting Started with Shield Advanced] and [Adding Shield Advanced protection to Amazon Web Services resources].

[1]: console.aws.amazon.com/wafv2/shieldv2#/ [2]: docs.aws.amazon.com/waf/latest/developerguide/getting-started-ddos.html [3]: docs.aws.amazon.com/waf/latest/developerguide/configure-new-protection.html

Examples:

Request syntax with placeholder values


resp = client.create_protection({
  name: "ProtectionName", # required
  resource_arn: "ResourceArn", # required
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

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 Amazon CloudFront distribution: ‘arn:aws:cloudfront::account-id:distribution/distribution-id `

    • For an Global Accelerator standard 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 `

  • :tags (Array<Types::Tag>) —

    One or more tag key-value pairs for the Protection object that is created.

Returns:

See Also:



663
664
665
666
 
# File 'lib/aws-sdk-shield/client.rb', line 663

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

#create_protection_group(params = {}) ⇒ Struct

Creates a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.

Examples:

Request syntax with placeholder values


resp = client.create_protection_group({
  protection_group_id: "ProtectionGroupId", # required
  aggregation: "SUM", # required, accepts SUM, MEAN, MAX
  pattern: "ALL", # required, accepts ALL, ARBITRARY, BY_RESOURCE_TYPE
  resource_type: "CLOUDFRONT_DISTRIBUTION", # accepts CLOUDFRONT_DISTRIBUTION, ROUTE_53_HOSTED_ZONE, ELASTIC_IP_ALLOCATION, CLASSIC_LOAD_BALANCER, APPLICATION_LOAD_BALANCER, GLOBAL_ACCELERATOR
  members: ["ResourceArn"],
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :protection_group_id (required, String) —

    The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.

  • :aggregation (required, String) —

    Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.

    • Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically.

    • Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers.

    • Max - Use the highest traffic from each resource. This is useful for resources that don’t share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront and origin resources for CloudFront distributions.

  • :pattern (required, String) —

    The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource Amazon Resource Names (ARNs), or include all resources of a specified resource type.

  • :resource_type (String) —

    The resource type to include in the protection group. All protected resources of this type are included in the protection group. Newly protected resources of this type are automatically added to the group. You must set this when you set ‘Pattern` to `BY_RESOURCE_TYPE` and you must not set it for any other `Pattern` setting.

  • :members (Array<String>) —

    The Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set ‘Pattern` to `ARBITRARY` and you must not set it for any other `Pattern` setting.

  • :tags (Array<Types::Tag>) —

    One or more tag key-value pairs for the protection group.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



737
738
739
740
 
# File 'lib/aws-sdk-shield/client.rb', line 737

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

#create_subscription(params = {}) ⇒ Struct

Activates Shield Advanced for an account.

<note markdown=“1”> For accounts that are members of an Organizations organization, Shield Advanced subscriptions are billed against the organization’s payer account, regardless of whether the payer account itself is subscribed.

</note>

When you initially 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:



761
762
763
764
 
# File 'lib/aws-sdk-shield/client.rb', line 761

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

#delete_protection(params = {}) ⇒ Struct

Deletes an 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:



783
784
785
786
 
# File 'lib/aws-sdk-shield/client.rb', line 783

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

#delete_protection_group(params = {}) ⇒ Struct

Removes the specified protection group.

Examples:

Request syntax with placeholder values


resp = client.delete_protection_group({
  protection_group_id: "ProtectionGroupId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :protection_group_id (required, String) —

    The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



807
808
809
810
 
# File 'lib/aws-sdk-shield/client.rb', line 807

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

#delete_subscription(params = {}) ⇒ Struct

Removes Shield Advanced from an account. 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:



822
823
824
825
 
# File 'lib/aws-sdk-shield/client.rb', line 822

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.

Returns:

See Also:



889
890
891
892
 
# File 'lib/aws-sdk-shield/client.rb', line 889

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

#describe_attack_statistics(params = {}) ⇒ Types::DescribeAttackStatisticsResponse

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. This operation is available to Shield customers as well as to Shield Advanced customers.

The operation returns data for the time range of midnight UTC, one year ago, to midnight UTC, today. For example, if the current time is ‘2020-10-26 15:39:32 PDT`, equal to `2020-10-26 22:39:32 UTC`, then the time range for the attack data returned is from `2019-10-26 00:00:00 UTC` to `2020-10-26 00:00:00 UTC`.

The time range indicates the period covered by the attack statistics data items.

Examples:

Response structure


resp.time_range.from_inclusive #=> Time
resp.time_range.to_exclusive #=> Time
resp.data_items #=> Array
resp.data_items[0].attack_volume.bits_per_second.max #=> Float
resp.data_items[0].attack_volume.packets_per_second.max #=> Float
resp.data_items[0].attack_volume.requests_per_second.max #=> Float
resp.data_items[0].attack_count #=> Integer

Parameters:

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

    ({})

Returns:

See Also:



928
929
930
931
 
# File 'lib/aws-sdk-shield/client.rb', line 928

def describe_attack_statistics(params = {}, options = {})
  req = build_request(:describe_attack_statistics, 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 Shield Response Team (SRT) to access your Amazon Web Services 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:



952
953
954
955
 
# File 'lib/aws-sdk-shield/client.rb', line 952

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 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.

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:



977
978
979
980
 
# File 'lib/aws-sdk-shield/client.rb', line 977

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
resp.protection.protection_arn #=> String
resp.protection.application_layer_automatic_response_configuration.status #=> String, one of "ENABLED", "DISABLED"

Parameters:

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

    ({})

Options Hash (params):

  • :protection_id (String) —

    The unique identifier (ID) for the Protection object to describe. You must provide either the ‘ResourceArn` of the protected resource or the `ProtectionID` of the protection, but not both.

  • :resource_arn (String) —

    The ARN (Amazon Resource Name) of the protected Amazon Web Services resource. You must provide either the ‘ResourceArn` of the protected resource or the `ProtectionID` of the protection, but not both.

Returns:

See Also:



1019
1020
1021
1022
 
# File 'lib/aws-sdk-shield/client.rb', line 1019

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

#describe_protection_group(params = {}) ⇒ Types::DescribeProtectionGroupResponse

Returns the specification for the specified protection group.

Examples:

Request syntax with placeholder values


resp = client.describe_protection_group({
  protection_group_id: "ProtectionGroupId", # required
})

Response structure


resp.protection_group.protection_group_id #=> String
resp.protection_group.aggregation #=> String, one of "SUM", "MEAN", "MAX"
resp.protection_group.pattern #=> String, one of "ALL", "ARBITRARY", "BY_RESOURCE_TYPE"
resp.protection_group.resource_type #=> String, one of "CLOUDFRONT_DISTRIBUTION", "ROUTE_53_HOSTED_ZONE", "ELASTIC_IP_ALLOCATION", "CLASSIC_LOAD_BALANCER", "APPLICATION_LOAD_BALANCER", "GLOBAL_ACCELERATOR"
resp.protection_group.members #=> Array
resp.protection_group.members[0] #=> String
resp.protection_group.protection_group_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :protection_group_id (required, String) —

    The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.

Returns:

See Also:



1055
1056
1057
1058
 
# File 'lib/aws-sdk-shield/client.rb', line 1055

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

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

Provides details about the 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"
resp.subscription.subscription_limits.protection_limits.protected_resource_type_limits #=> Array
resp.subscription.subscription_limits.protection_limits.protected_resource_type_limits[0].type #=> String
resp.subscription.subscription_limits.protection_limits.protected_resource_type_limits[0].max #=> Integer
resp.subscription.subscription_limits.protection_group_limits.max_protection_groups #=> Integer
resp.subscription.subscription_limits.protection_group_limits.pattern_type_limits.arbitrary_pattern_limits.max_members #=> Integer
resp.subscription.subscription_arn #=> String

Parameters:

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

    ({})

Returns:

See Also:



1088
1089
1090
1091
 
# File 'lib/aws-sdk-shield/client.rb', line 1088

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

#disable_application_layer_automatic_response(params = {}) ⇒ Struct

Disable the Shield Advanced automatic application layer DDoS mitigation feature for the protected resource. This stops Shield Advanced from creating, verifying, and applying WAF rules for attacks that it detects for the resource.

Examples:

Request syntax with placeholder values


resp = client.disable_application_layer_automatic_response({
  resource_arn: "ResourceArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1113
1114
1115
1116
 
# File 'lib/aws-sdk-shield/client.rb', line 1113

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

#disable_proactive_engagement(params = {}) ⇒ Struct

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

Parameters:

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

    ({})

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

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 Shield Response Team’s (SRT) access to the specified Amazon S3 bucket containing the logs that you shared previously.

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 the logs that you want to share.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1151
1152
1153
1154
 
# File 'lib/aws-sdk-shield/client.rb', line 1151

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 Shield Response Team’s (SRT) access to your Amazon Web Services account.

Parameters:

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

    ({})

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

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 Amazon Web Services resource to improve responsiveness and accuracy in attack detection and response.

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 *WAF Developer Guide*.

[1]: docs.aws.amazon.com/waf/latest/developerguide/ddos-overview.html#ddos-advanced-health-check-option

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:



1205
1206
1207
1208
 
# File 'lib/aws-sdk-shield/client.rb', line 1205

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

#enable_application_layer_automatic_response(params = {}) ⇒ Struct

Enable the Shield Advanced automatic application layer DDoS mitigation for the protected resource.

<note markdown=“1”> This feature is available for Amazon CloudFront distributions and Application Load Balancers only.

</note>

This causes Shield Advanced to create, verify, and apply WAF rules for DDoS attacks that it detects for the resource. Shield Advanced applies the rules in a Shield rule group inside the web ACL that you’ve associated with the resource. For information about how automatic mitigation works and the requirements for using it, see [Shield Advanced automatic application layer DDoS mitigation].

<note markdown=“1”> Don’t use this action to make changes to automatic mitigation settings when it’s already enabled for a resource. Instead, use UpdateApplicationLayerAutomaticResponse.

</note>

To use this feature, you must associate a web ACL with the protected resource. The web ACL must be created using the latest version of WAF (v2). You can associate the web ACL through the Shield Advanced console at [console.aws.amazon.com/wafv2/shieldv2#/][2]. For more information, see [Getting Started with Shield Advanced]. You can also associate the web ACL to the resource through the WAF console or the WAF API, but you must manage Shield Advanced automatic mitigation through Shield Advanced. For information about WAF, see [WAF Developer Guide].

[1]: docs.aws.amazon.com/waf/latest/developerguide/ddos-advanced-automatic-app-layer-response.html [2]: console.aws.amazon.com/wafv2/shieldv2#/ [3]: docs.aws.amazon.com/waf/latest/developerguide/getting-started-ddos.html [4]: docs.aws.amazon.com/waf/latest/developerguide/

Examples:

Request syntax with placeholder values


resp = client.enable_application_layer_automatic_response({
  resource_arn: "ResourceArn", # required
  action: { # required
    block: {
    },
    count: {
    },
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

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

  • :action (required, Types::ResponseAction) —

    Specifies the action setting that Shield Advanced should use in the WAF rules that it creates on behalf of the protected resource in response to DDoS attacks. You specify this as part of the configuration for the automatic application layer DDoS mitigation feature, when you enable or update automatic mitigation. Shield Advanced creates the WAF rules in a Shield Advanced-managed rule group, inside the web ACL that you have associated with the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1278
1279
1280
1281
 
# File 'lib/aws-sdk-shield/client.rb', line 1278

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

#enable_proactive_engagement(params = {}) ⇒ Struct

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.

Parameters:

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

    ({})

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1293
1294
1295
1296
 
# File 'lib/aws-sdk-shield/client.rb', line 1293

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:



1312
1313
1314
1315
 
# File 'lib/aws-sdk-shield/client.rb', line 1312

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 ARNs (Amazon Resource Names) of the resources that were attacked. If you leave this 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 request syntax listing for this call indicates a `number` type, but you can provide the time in any valid [timestamp format] setting.

    [1]: docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp

  • :end_time (Types::TimeRange) —

    The end of the time period for the attacks. This is a ‘timestamp` type. The request syntax listing for this call indicates a `number` type, but you can provide the time in any valid [timestamp format] setting.

    [1]: docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp

  • :next_token (String) —

    When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a ‘NextToken` value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.

    You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the ‘MaxResults` setting. Shield Advanced will not return more than `MaxResults` objects, but may return fewer, even if more objects are still available.

    Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a ‘NextToken` value.

    On your first call to a list operation, leave this setting empty.

  • :max_results (Integer) —

    The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects than you indicate in this setting, even if more objects are available. If there are more objects remaining, Shield Advanced will always also return a ‘NextToken` value in the response.

    The default setting is 20.

Returns:

See Also:



1410
1411
1412
1413
 
# File 'lib/aws-sdk-shield/client.rb', line 1410

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

#list_protection_groups(params = {}) ⇒ Types::ListProtectionGroupsResponse

Retrieves ProtectionGroup objects for the account. You can retrieve all protection groups or you can provide filtering criteria and retrieve just the subset of protection groups that match the criteria.

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_protection_groups({
  next_token: "Token",
  max_results: 1,
  inclusion_filters: {
    protection_group_ids: ["ProtectionGroupId"],
    patterns: ["ALL"], # accepts ALL, ARBITRARY, BY_RESOURCE_TYPE
    resource_types: ["CLOUDFRONT_DISTRIBUTION"], # accepts CLOUDFRONT_DISTRIBUTION, ROUTE_53_HOSTED_ZONE, ELASTIC_IP_ALLOCATION, CLASSIC_LOAD_BALANCER, APPLICATION_LOAD_BALANCER, GLOBAL_ACCELERATOR
    aggregations: ["SUM"], # accepts SUM, MEAN, MAX
  },
})

Response structure


resp.protection_groups #=> Array
resp.protection_groups[0].protection_group_id #=> String
resp.protection_groups[0].aggregation #=> String, one of "SUM", "MEAN", "MAX"
resp.protection_groups[0].pattern #=> String, one of "ALL", "ARBITRARY", "BY_RESOURCE_TYPE"
resp.protection_groups[0].resource_type #=> String, one of "CLOUDFRONT_DISTRIBUTION", "ROUTE_53_HOSTED_ZONE", "ELASTIC_IP_ALLOCATION", "CLASSIC_LOAD_BALANCER", "APPLICATION_LOAD_BALANCER", "GLOBAL_ACCELERATOR"
resp.protection_groups[0].members #=> Array
resp.protection_groups[0].members[0] #=> String
resp.protection_groups[0].protection_group_arn #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a ‘NextToken` value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.

    You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the ‘MaxResults` setting. Shield Advanced will not return more than `MaxResults` objects, but may return fewer, even if more objects are still available.

    Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a ‘NextToken` value.

    On your first call to a list operation, leave this setting empty.

  • :max_results (Integer) —

    The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects than you indicate in this setting, even if more objects are available. If there are more objects remaining, Shield Advanced will always also return a ‘NextToken` value in the response.

    The default setting is 20.

  • :inclusion_filters (Types::InclusionProtectionGroupFilters) —

    Narrows the set of protection groups that the call retrieves. You can retrieve a single protection group by its name and you can retrieve all protection groups that are configured with specific pattern or aggregation settings. You can provide up to one criteria per filter type. Shield Advanced returns the protection groups that exactly match all of the search criteria that you provide.

Returns:

See Also:



1490
1491
1492
1493
 
# File 'lib/aws-sdk-shield/client.rb', line 1490

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

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

Retrieves Protection objects for the account. You can retrieve all protections or you can provide filtering criteria and retrieve just the subset of protections that match the criteria.

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,
  inclusion_filters: {
    resource_arns: ["ResourceArn"],
    protection_names: ["ProtectionName"],
    resource_types: ["CLOUDFRONT_DISTRIBUTION"], # accepts CLOUDFRONT_DISTRIBUTION, ROUTE_53_HOSTED_ZONE, ELASTIC_IP_ALLOCATION, CLASSIC_LOAD_BALANCER, APPLICATION_LOAD_BALANCER, GLOBAL_ACCELERATOR
  },
})

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.protections[0].protection_arn #=> String
resp.protections[0].application_layer_automatic_response_configuration.status #=> String, one of "ENABLED", "DISABLED"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a ‘NextToken` value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.

    You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the ‘MaxResults` setting. Shield Advanced will not return more than `MaxResults` objects, but may return fewer, even if more objects are still available.

    Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a ‘NextToken` value.

    On your first call to a list operation, leave this setting empty.

  • :max_results (Integer) —

    The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects than you indicate in this setting, even if more objects are available. If there are more objects remaining, Shield Advanced will always also return a ‘NextToken` value in the response.

    The default setting is 20.

  • :inclusion_filters (Types::InclusionProtectionFilters) —

    Narrows the set of protections that the call retrieves. You can retrieve a single protection by providing its name or the ARN (Amazon Resource Name) of its protected resource. You can also retrieve all protections for a specific resource type. You can provide up to one criteria per filter type. Shield Advanced returns protections that exactly match all of the filter criteria that you provide.

Returns:

See Also:



1569
1570
1571
1572
 
# File 'lib/aws-sdk-shield/client.rb', line 1569

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

#list_resources_in_protection_group(params = {}) ⇒ Types::ListResourcesInProtectionGroupResponse

Retrieves the resources that are included in the protection group.

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_resources_in_protection_group({
  protection_group_id: "ProtectionGroupId", # required
  next_token: "Token",
  max_results: 1,
})

Response structure


resp.resource_arns #=> Array
resp.resource_arns[0] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :protection_group_id (required, String) —

    The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.

  • :next_token (String) —

    When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a ‘NextToken` value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.

    You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the ‘MaxResults` setting. Shield Advanced will not return more than `MaxResults` objects, but may return fewer, even if more objects are still available.

    Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a ‘NextToken` value.

    On your first call to a list operation, leave this setting empty.

  • :max_results (Integer) —

    The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects than you indicate in this setting, even if more objects are available. If there are more objects remaining, Shield Advanced will always also return a ‘NextToken` value in the response.

    The default setting is 20.

Returns:

See Also:



1633
1634
1635
1636
 
# File 'lib/aws-sdk-shield/client.rb', line 1633

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

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in Shield.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "ResourceArn", # required
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource to get tags for.

Returns:

See Also:



1664
1665
1666
1667
 
# File 'lib/aws-sdk-shield/client.rb', line 1664

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

#tag_resource(params = {}) ⇒ Struct

Adds or updates tags for a resource in Shield.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "ResourceArn", # required
  tags: [ # required
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource that you want to add or update tags for.

  • :tags (required, Array<Types::Tag>) —

    The tags that you want to modify or add to the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1696
1697
1698
1699
 
# File 'lib/aws-sdk-shield/client.rb', line 1696

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

#untag_resource(params = {}) ⇒ Struct

Removes tags from a resource in Shield.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "ResourceArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource that you want to remove tags from.

  • :tag_keys (required, Array<String>) —

    The tag key for each tag that you want to remove from the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1723
1724
1725
1726
 
# File 'lib/aws-sdk-shield/client.rb', line 1723

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

#update_application_layer_automatic_response(params = {}) ⇒ Struct

Updates an existing Shield Advanced automatic application layer DDoS mitigation configuration for the specified resource.

Examples:

Request syntax with placeholder values


resp = client.update_application_layer_automatic_response({
  resource_arn: "ResourceArn", # required
  action: { # required
    block: {
    },
    count: {
    },
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN (Amazon Resource Name) of the resource.

  • :action (required, Types::ResponseAction) —

    Specifies the action setting that Shield Advanced should use in the WAF rules that it creates on behalf of the protected resource in response to DDoS attacks. You specify this as part of the configuration for the automatic application layer DDoS mitigation feature, when you enable or update automatic mitigation. Shield Advanced creates the WAF rules in a Shield Advanced-managed rule group, inside the web ACL that you have associated with the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1761
1762
1763
1764
 
# File 'lib/aws-sdk-shield/client.rb', line 1761

def update_application_layer_automatic_response(params = {}, options = {})
  req = build_request(:update_application_layer_automatic_response, 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 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.

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 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.

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1798
1799
1800
1801
 
# File 'lib/aws-sdk-shield/client.rb', line 1798

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

#update_protection_group(params = {}) ⇒ Struct

Updates an existing protection group. A protection group is a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.

Examples:

Request syntax with placeholder values


resp = client.update_protection_group({
  protection_group_id: "ProtectionGroupId", # required
  aggregation: "SUM", # required, accepts SUM, MEAN, MAX
  pattern: "ALL", # required, accepts ALL, ARBITRARY, BY_RESOURCE_TYPE
  resource_type: "CLOUDFRONT_DISTRIBUTION", # accepts CLOUDFRONT_DISTRIBUTION, ROUTE_53_HOSTED_ZONE, ELASTIC_IP_ALLOCATION, CLASSIC_LOAD_BALANCER, APPLICATION_LOAD_BALANCER, GLOBAL_ACCELERATOR
  members: ["ResourceArn"],
})

Parameters:

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

    ({})

Options Hash (params):

  • :protection_group_id (required, String) —

    The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.

  • :aggregation (required, String) —

    Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.

    • Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically.

    • Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers.

    • Max - Use the highest traffic from each resource. This is useful for resources that don’t share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront distributions and origin resources for CloudFront distributions.

  • :pattern (required, String) —

    The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource Amazon Resource Names (ARNs), or include all resources of a specified resource type.

  • :resource_type (String) —

    The resource type to include in the protection group. All protected resources of this type are included in the protection group. You must set this when you set ‘Pattern` to `BY_RESOURCE_TYPE` and you must not set it for any other `Pattern` setting.

  • :members (Array<String>) —

    The Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set ‘Pattern` to `ARBITRARY` and you must not set it for any other `Pattern` setting.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1864
1865
1866
1867
 
# File 'lib/aws-sdk-shield/client.rb', line 1864

def update_protection_group(params = {}, options = {})
  req = build_request(:update_protection_group, 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.

<note markdown=“1”> For accounts that are members of an Organizations organization, Shield Advanced subscriptions are billed against the organization’s payer account, regardless of whether the payer account itself is subscribed.

</note>

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:



1898
1899
1900
1901
 
# File 'lib/aws-sdk-shield/client.rb', line 1898

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

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


1922
1923
1924
 
# File 'lib/aws-sdk-shield/client.rb', line 1922

def waiter_names
  []
end