Struct aws_sdk_shield::Client

source ·
pub struct Client { /* private fields */ }
Expand description

Client for AWS Shield

Client for invoking operations on AWS Shield. Each operation on AWS Shield is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_shield::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::retry::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_shield::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_shield::Client::from_conf(config);

Implementations§

Creates a client with the given service configuration.

Returns the client’s configuration.

Constructs a fluent builder for the AssociateDRTLogBucket operation.

Constructs a fluent builder for the AssociateDRTRole operation.

Constructs a fluent builder for the AssociateHealthCheck operation.

Constructs a fluent builder for the AssociateProactiveEngagementDetails operation.

Constructs a fluent builder for the CreateProtection operation.

  • The fluent builder is configurable:
    • name(impl Into<String>) / set_name(Option<String>):

      Friendly name for the Protection you are creating.

    • resource_arn(impl Into<String>) / set_resource_arn(Option<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(Vec<Tag>) / set_tags(Option<Vec<Tag>>):

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

  • On success, responds with CreateProtectionOutput with field(s):
  • On failure, responds with SdkError<CreateProtectionError>

Constructs a fluent builder for the CreateProtectionGroup operation.

Constructs a fluent builder for the CreateSubscription operation.

Constructs a fluent builder for the DeleteProtection operation.

Constructs a fluent builder for the DeleteProtectionGroup operation.

Constructs a fluent builder for the DeleteSubscription operation.

Constructs a fluent builder for the DescribeAttack operation.

Constructs a fluent builder for the DescribeAttackStatistics operation.

Constructs a fluent builder for the DescribeDRTAccess operation.

Constructs a fluent builder for the DescribeEmergencyContactSettings operation.

Constructs a fluent builder for the DescribeProtection operation.

Constructs a fluent builder for the DescribeProtectionGroup operation.

Constructs a fluent builder for the DescribeSubscription operation.

Constructs a fluent builder for the DisableApplicationLayerAutomaticResponse operation.

Constructs a fluent builder for the DisableProactiveEngagement operation.

Constructs a fluent builder for the DisassociateDRTLogBucket operation.

Constructs a fluent builder for the DisassociateDRTRole operation.

Constructs a fluent builder for the DisassociateHealthCheck operation.

Constructs a fluent builder for the EnableApplicationLayerAutomaticResponse operation.

Constructs a fluent builder for the EnableProactiveEngagement operation.

Constructs a fluent builder for the GetSubscriptionState operation.

Constructs a fluent builder for the ListAttacks operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • resource_arns(Vec<String>) / set_resource_arns(Option<Vec<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(TimeRange) / set_start_time(Option<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.

    • end_time(TimeRange) / set_end_time(Option<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.

    • next_token(impl Into<String>) / set_next_token(Option<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(i32) / set_max_results(Option<i32>):

      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.

  • On success, responds with ListAttacksOutput with field(s):
    • attack_summaries(Option<Vec<AttackSummary>>):

      The attack information for the specified time range.

    • next_token(Option<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 failure, responds with SdkError<ListAttacksError>

Constructs a fluent builder for the ListProtectionGroups operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • next_token(impl Into<String>) / set_next_token(Option<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(i32) / set_max_results(Option<i32>):

      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(InclusionProtectionGroupFilters) / set_inclusion_filters(Option<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.

  • On success, responds with ListProtectionGroupsOutput with field(s):
    • protection_groups(Option<Vec<ProtectionGroup>>):

    • next_token(Option<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 failure, responds with SdkError<ListProtectionGroupsError>

Constructs a fluent builder for the ListProtections operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • next_token(impl Into<String>) / set_next_token(Option<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(i32) / set_max_results(Option<i32>):

      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(InclusionProtectionFilters) / set_inclusion_filters(Option<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.

  • On success, responds with ListProtectionsOutput with field(s):
    • protections(Option<Vec<Protection>>):

      The array of enabled Protection objects.

    • next_token(Option<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 failure, responds with SdkError<ListProtectionsError>

Constructs a fluent builder for the ListResourcesInProtectionGroup operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • protection_group_id(impl Into<String>) / set_protection_group_id(Option<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(impl Into<String>) / set_next_token(Option<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(i32) / set_max_results(Option<i32>):

      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.

  • On success, responds with ListResourcesInProtectionGroupOutput with field(s):
    • resource_arns(Option<Vec<String>>):

      The Amazon Resource Names (ARNs) of the resources that are included in the protection group.

    • next_token(Option<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 failure, responds with SdkError<ListResourcesInProtectionGroupError>

Constructs a fluent builder for the ListTagsForResource operation.

Constructs a fluent builder for the TagResource operation.

Constructs a fluent builder for the UntagResource operation.

Constructs a fluent builder for the UpdateApplicationLayerAutomaticResponse operation.

Constructs a fluent builder for the UpdateEmergencyContactSettings operation.

Constructs a fluent builder for the UpdateProtectionGroup operation.

Constructs a fluent builder for the UpdateSubscription operation.

  • The fluent builder is configurable:
    • auto_renew(AutoRenew) / set_auto_renew(Option<AutoRenew>):

      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.

  • On success, responds with UpdateSubscriptionOutput
  • On failure, responds with SdkError<UpdateSubscriptionError>

Creates a new client from an SDK Config.

Panics
  • This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
  • This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

Creates a new client from the service Config.

Panics
  • This method will panic if the conf is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
  • This method will panic if the conf is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

Trait Implementations§

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.
Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more