Struct aws_sdk_shield::client::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::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
sourceimpl Client
impl Client
sourcepub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
Creates a client with the given service configuration.
sourceimpl Client
impl Client
sourcepub fn associate_drt_log_bucket(&self) -> AssociateDRTLogBucket
pub fn associate_drt_log_bucket(&self) -> AssociateDRTLogBucket
Constructs a fluent builder for the AssociateDRTLogBucket operation.
- The fluent builder is configurable:
log_bucket(impl Into<String>)/set_log_bucket(Option<String>):The Amazon S3 bucket that contains the logs that you want to share.
- On success, responds with
AssociateDrtLogBucketOutput - On failure, responds with
SdkError<AssociateDRTLogBucketError>
sourcepub fn associate_drt_role(&self) -> AssociateDRTRole
pub fn associate_drt_role(&self) -> AssociateDRTRole
Constructs a fluent builder for the AssociateDRTRole operation.
- The fluent builder is configurable:
role_arn(impl Into<String>)/set_role_arn(Option<String>):The Amazon Resource Name (ARN) of the role the SRT will use to access your Amazon Web Services account.
Prior to making the
AssociateDRTRolerequest, you must attach the AWSShieldDRTAccessPolicy managed policy to this role. For more information see Attaching and Detaching IAM Policies.
- On success, responds with
AssociateDrtRoleOutput - On failure, responds with
SdkError<AssociateDRTRoleError>
sourcepub fn associate_health_check(&self) -> AssociateHealthCheck
pub fn associate_health_check(&self) -> AssociateHealthCheck
Constructs a fluent builder for the AssociateHealthCheck operation.
- The fluent builder is configurable:
protection_id(impl Into<String>)/set_protection_id(Option<String>):The unique identifier (ID) for the
Protectionobject to add the health check association to.health_check_arn(impl Into<String>)/set_health_check_arn(Option<String>):The Amazon Resource Name (ARN) of the health check to associate with the protection.
- On success, responds with
AssociateHealthCheckOutput - On failure, responds with
SdkError<AssociateHealthCheckError>
sourcepub fn associate_proactive_engagement_details(
&self
) -> AssociateProactiveEngagementDetails
pub fn associate_proactive_engagement_details(
&self
) -> AssociateProactiveEngagementDetails
Constructs a fluent builder for the AssociateProactiveEngagementDetails operation.
- The fluent builder is configurable:
emergency_contact_list(Vec<EmergencyContact>)/set_emergency_contact_list(Option<Vec<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.
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
DescribeEmergencyContactSettingsand then provide it here.
- On success, responds with
AssociateProactiveEngagementDetailsOutput - On failure, responds with
SdkError<AssociateProactiveEngagementDetailsError>
sourcepub fn create_protection(&self) -> CreateProtection
pub fn create_protection(&self) -> CreateProtection
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
Protectionyou 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 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
Protectionobject that is created.
- On success, responds with
CreateProtectionOutputwith field(s):protection_id(Option<String>):The unique identifier (ID) for the
Protectionobject that is created.
- On failure, responds with
SdkError<CreateProtectionError>
sourcepub fn create_protection_group(&self) -> CreateProtectionGroup
pub fn create_protection_group(&self) -> CreateProtectionGroup
Constructs a fluent builder for the CreateProtectionGroup operation.
- 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.
aggregation(ProtectionGroupAggregation)/set_aggregation(Option<ProtectionGroupAggregation>):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(ProtectionGroupPattern)/set_pattern(Option<ProtectionGroupPattern>):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(ProtectedResourceType)/set_resource_type(Option<ProtectedResourceType>):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
PatterntoBY_RESOURCE_TYPEand you must not set it for any otherPatternsetting.members(Vec<String>)/set_members(Option<Vec<String>>):The Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set
PatterntoARBITRARYand you must not set it for any otherPatternsetting.tags(Vec<Tag>)/set_tags(Option<Vec<Tag>>):One or more tag key-value pairs for the protection group.
- On success, responds with
CreateProtectionGroupOutput - On failure, responds with
SdkError<CreateProtectionGroupError>
sourcepub fn create_subscription(&self) -> CreateSubscription
pub fn create_subscription(&self) -> CreateSubscription
Constructs a fluent builder for the CreateSubscription operation.
- The fluent builder takes no input, just
sendit. - On success, responds with
CreateSubscriptionOutput - On failure, responds with
SdkError<CreateSubscriptionError>
sourcepub fn delete_protection(&self) -> DeleteProtection
pub fn delete_protection(&self) -> DeleteProtection
Constructs a fluent builder for the DeleteProtection operation.
- The fluent builder is configurable:
protection_id(impl Into<String>)/set_protection_id(Option<String>):The unique identifier (ID) for the
Protectionobject to be deleted.
- On success, responds with
DeleteProtectionOutput - On failure, responds with
SdkError<DeleteProtectionError>
sourcepub fn delete_protection_group(&self) -> DeleteProtectionGroup
pub fn delete_protection_group(&self) -> DeleteProtectionGroup
Constructs a fluent builder for the DeleteProtectionGroup operation.
- 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.
- On success, responds with
DeleteProtectionGroupOutput - On failure, responds with
SdkError<DeleteProtectionGroupError>
sourcepub fn delete_subscription(&self) -> DeleteSubscription
pub fn delete_subscription(&self) -> DeleteSubscription
Constructs a fluent builder for the DeleteSubscription operation.
- The fluent builder takes no input, just
sendit. - On success, responds with
DeleteSubscriptionOutput - On failure, responds with
SdkError<DeleteSubscriptionError>
sourcepub fn describe_attack(&self) -> DescribeAttack
pub fn describe_attack(&self) -> DescribeAttack
Constructs a fluent builder for the DescribeAttack operation.
- The fluent builder is configurable:
attack_id(impl Into<String>)/set_attack_id(Option<String>):The unique identifier (ID) for the attack.
- On success, responds with
DescribeAttackOutputwith field(s):attack(Option<AttackDetail>):The attack that is described.
- On failure, responds with
SdkError<DescribeAttackError>
sourcepub fn describe_attack_statistics(&self) -> DescribeAttackStatistics
pub fn describe_attack_statistics(&self) -> DescribeAttackStatistics
Constructs a fluent builder for the DescribeAttackStatistics operation.
- The fluent builder takes no input, just
sendit. - On success, responds with
DescribeAttackStatisticsOutputwith field(s):time_range(Option<TimeRange>):The time range.
data_items(Option<Vec<AttackStatisticsDataItem>>):The data that describes the attacks detected during the time period.
- On failure, responds with
SdkError<DescribeAttackStatisticsError>
sourcepub fn describe_drt_access(&self) -> DescribeDRTAccess
pub fn describe_drt_access(&self) -> DescribeDRTAccess
Constructs a fluent builder for the DescribeDRTAccess operation.
- The fluent builder takes no input, just
sendit. - On success, responds with
DescribeDrtAccessOutputwith field(s):role_arn(Option<String>):The Amazon Resource Name (ARN) of the role the SRT used to access your Amazon Web Services account.
log_bucket_list(Option<Vec<String>>):The list of Amazon S3 buckets accessed by the SRT.
- On failure, responds with
SdkError<DescribeDRTAccessError>
sourcepub fn describe_emergency_contact_settings(
&self
) -> DescribeEmergencyContactSettings
pub fn describe_emergency_contact_settings(
&self
) -> DescribeEmergencyContactSettings
Constructs a fluent builder for the DescribeEmergencyContactSettings operation.
- The fluent builder takes no input, just
sendit. - On success, responds with
DescribeEmergencyContactSettingsOutputwith field(s):emergency_contact_list(Option<Vec<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.
- On failure, responds with
SdkError<DescribeEmergencyContactSettingsError>
sourcepub fn describe_protection(&self) -> DescribeProtection
pub fn describe_protection(&self) -> DescribeProtection
Constructs a fluent builder for the DescribeProtection operation.
- The fluent builder is configurable:
protection_id(impl Into<String>)/set_protection_id(Option<String>):The unique identifier (ID) for the
Protectionobject that is described. When submitting theDescribeProtectionrequest you must provide either theResourceArnor theProtectionID, but not both.resource_arn(impl Into<String>)/set_resource_arn(Option<String>):The ARN (Amazon Resource Name) of the Amazon Web Services resource for the
Protectionobject that is described. When submitting theDescribeProtectionrequest you must provide either theResourceArnor theProtectionID, but not both.
- On success, responds with
DescribeProtectionOutputwith field(s):protection(Option<Protection>):The
Protectionobject that is described.
- On failure, responds with
SdkError<DescribeProtectionError>
sourcepub fn describe_protection_group(&self) -> DescribeProtectionGroup
pub fn describe_protection_group(&self) -> DescribeProtectionGroup
Constructs a fluent builder for the DescribeProtectionGroup operation.
- 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.
- On success, responds with
DescribeProtectionGroupOutputwith field(s):protection_group(Option<ProtectionGroup>):A grouping of protected resources that you and Shield Advanced can monitor as a collective. This resource grouping improves the accuracy of detection and reduces false positives.
- On failure, responds with
SdkError<DescribeProtectionGroupError>
sourcepub fn describe_subscription(&self) -> DescribeSubscription
pub fn describe_subscription(&self) -> DescribeSubscription
Constructs a fluent builder for the DescribeSubscription operation.
- The fluent builder takes no input, just
sendit. - On success, responds with
DescribeSubscriptionOutputwith field(s):subscription(Option<Subscription>):The Shield Advanced subscription details for an account.
- On failure, responds with
SdkError<DescribeSubscriptionError>
sourcepub fn disable_application_layer_automatic_response(
&self
) -> DisableApplicationLayerAutomaticResponse
pub fn disable_application_layer_automatic_response(
&self
) -> DisableApplicationLayerAutomaticResponse
Constructs a fluent builder for the DisableApplicationLayerAutomaticResponse operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):The ARN (Amazon Resource Name) of the resource.
- On success, responds with
DisableApplicationLayerAutomaticResponseOutput - On failure, responds with
SdkError<DisableApplicationLayerAutomaticResponseError>
sourcepub fn disable_proactive_engagement(&self) -> DisableProactiveEngagement
pub fn disable_proactive_engagement(&self) -> DisableProactiveEngagement
Constructs a fluent builder for the DisableProactiveEngagement operation.
- The fluent builder takes no input, just
sendit. - On success, responds with
DisableProactiveEngagementOutput - On failure, responds with
SdkError<DisableProactiveEngagementError>
sourcepub fn disassociate_drt_log_bucket(&self) -> DisassociateDRTLogBucket
pub fn disassociate_drt_log_bucket(&self) -> DisassociateDRTLogBucket
Constructs a fluent builder for the DisassociateDRTLogBucket operation.
- The fluent builder is configurable:
log_bucket(impl Into<String>)/set_log_bucket(Option<String>):The Amazon S3 bucket that contains the logs that you want to share.
- On success, responds with
DisassociateDrtLogBucketOutput - On failure, responds with
SdkError<DisassociateDRTLogBucketError>
sourcepub fn disassociate_drt_role(&self) -> DisassociateDRTRole
pub fn disassociate_drt_role(&self) -> DisassociateDRTRole
Constructs a fluent builder for the DisassociateDRTRole operation.
- The fluent builder takes no input, just
sendit. - On success, responds with
DisassociateDrtRoleOutput - On failure, responds with
SdkError<DisassociateDRTRoleError>
sourcepub fn disassociate_health_check(&self) -> DisassociateHealthCheck
pub fn disassociate_health_check(&self) -> DisassociateHealthCheck
Constructs a fluent builder for the DisassociateHealthCheck operation.
- The fluent builder is configurable:
protection_id(impl Into<String>)/set_protection_id(Option<String>):The unique identifier (ID) for the
Protectionobject to remove the health check association from.health_check_arn(impl Into<String>)/set_health_check_arn(Option<String>):The Amazon Resource Name (ARN) of the health check that is associated with the protection.
- On success, responds with
DisassociateHealthCheckOutput - On failure, responds with
SdkError<DisassociateHealthCheckError>
sourcepub fn enable_application_layer_automatic_response(
&self
) -> EnableApplicationLayerAutomaticResponse
pub fn enable_application_layer_automatic_response(
&self
) -> EnableApplicationLayerAutomaticResponse
Constructs a fluent builder for the EnableApplicationLayerAutomaticResponse operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):The ARN (Amazon Resource Name) of the resource.
action(ResponseAction)/set_action(Option<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.
- On success, responds with
EnableApplicationLayerAutomaticResponseOutput - On failure, responds with
SdkError<EnableApplicationLayerAutomaticResponseError>
sourcepub fn enable_proactive_engagement(&self) -> EnableProactiveEngagement
pub fn enable_proactive_engagement(&self) -> EnableProactiveEngagement
Constructs a fluent builder for the EnableProactiveEngagement operation.
- The fluent builder takes no input, just
sendit. - On success, responds with
EnableProactiveEngagementOutput - On failure, responds with
SdkError<EnableProactiveEngagementError>
sourcepub fn get_subscription_state(&self) -> GetSubscriptionState
pub fn get_subscription_state(&self) -> GetSubscriptionState
Constructs a fluent builder for the GetSubscriptionState operation.
- The fluent builder takes no input, just
sendit. - On success, responds with
GetSubscriptionStateOutputwith field(s):subscription_state(Option<SubscriptionState>):The status of the subscription.
- On failure, responds with
SdkError<GetSubscriptionStateError>
sourcepub fn list_attacks(&self) -> ListAttacks
pub fn list_attacks(&self) -> ListAttacks
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
timestamptype. The request syntax listing for this call indicates anumbertype, 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
timestamptype. The request syntax listing for this call indicates anumbertype, 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
NextTokenvalue 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
MaxResultssetting. Shield Advanced will not return more thanMaxResultsobjects, 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
NextTokenvalue.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
NextTokenvalue in the response.The default setting is 20.
- On success, responds with
ListAttacksOutputwith 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
NextTokenvalue 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
MaxResultssetting. Shield Advanced will not return more thanMaxResultsobjects, 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
NextTokenvalue.
- On failure, responds with
SdkError<ListAttacksError>
sourcepub fn list_protection_groups(&self) -> ListProtectionGroups
pub fn list_protection_groups(&self) -> ListProtectionGroups
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
NextTokenvalue 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
MaxResultssetting. Shield Advanced will not return more thanMaxResultsobjects, 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
NextTokenvalue.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
NextTokenvalue in the response.The default setting is 20.
- On success, responds with
ListProtectionGroupsOutputwith 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
NextTokenvalue 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
MaxResultssetting. Shield Advanced will not return more thanMaxResultsobjects, 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
NextTokenvalue.
- On failure, responds with
SdkError<ListProtectionGroupsError>
sourcepub fn list_protections(&self) -> ListProtections
pub fn list_protections(&self) -> ListProtections
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
NextTokenvalue 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
MaxResultssetting. Shield Advanced will not return more thanMaxResultsobjects, 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
NextTokenvalue.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
NextTokenvalue in the response.The default setting is 20.
- On success, responds with
ListProtectionsOutputwith field(s):protections(Option<Vec<Protection>>):The array of enabled
Protectionobjects.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
NextTokenvalue 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
MaxResultssetting. Shield Advanced will not return more thanMaxResultsobjects, 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
NextTokenvalue.
- On failure, responds with
SdkError<ListProtectionsError>
sourcepub fn list_resources_in_protection_group(
&self
) -> ListResourcesInProtectionGroup
pub fn list_resources_in_protection_group(
&self
) -> ListResourcesInProtectionGroup
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
NextTokenvalue 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
MaxResultssetting. Shield Advanced will not return more thanMaxResultsobjects, 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
NextTokenvalue.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
NextTokenvalue in the response.The default setting is 20.
- On success, responds with
ListResourcesInProtectionGroupOutputwith 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
NextTokenvalue 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
MaxResultssetting. Shield Advanced will not return more thanMaxResultsobjects, 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
NextTokenvalue.
- On failure, responds with
SdkError<ListResourcesInProtectionGroupError>
Constructs a fluent builder for the ListTagsForResource operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):The Amazon Resource Name (ARN) of the resource to get tags for.
- On success, responds with
ListTagsForResourceOutputwith field(s):tags(Option<Vec<Tag>>):A list of tag key and value pairs associated with the specified resource.
- On failure, responds with
SdkError<ListTagsForResourceError>
sourcepub fn tag_resource(&self) -> TagResource
pub fn tag_resource(&self) -> TagResource
Constructs a fluent builder for the TagResource operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):The Amazon Resource Name (ARN) of the resource that you want to add or update tags for.
tags(Vec<Tag>)/set_tags(Option<Vec<Tag>>):The tags that you want to modify or add to the resource.
- On success, responds with
TagResourceOutput - On failure, responds with
SdkError<TagResourceError>
sourcepub fn untag_resource(&self) -> UntagResource
pub fn untag_resource(&self) -> UntagResource
Constructs a fluent builder for the UntagResource operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):The Amazon Resource Name (ARN) of the resource that you want to remove tags from.
tag_keys(Vec<String>)/set_tag_keys(Option<Vec<String>>):The tag key for each tag that you want to remove from the resource.
- On success, responds with
UntagResourceOutput - On failure, responds with
SdkError<UntagResourceError>
sourcepub fn update_application_layer_automatic_response(
&self
) -> UpdateApplicationLayerAutomaticResponse
pub fn update_application_layer_automatic_response(
&self
) -> UpdateApplicationLayerAutomaticResponse
Constructs a fluent builder for the UpdateApplicationLayerAutomaticResponse operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):The ARN (Amazon Resource Name) of the resource.
action(ResponseAction)/set_action(Option<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.
- On success, responds with
UpdateApplicationLayerAutomaticResponseOutput - On failure, responds with
SdkError<UpdateApplicationLayerAutomaticResponseError>
sourcepub fn update_emergency_contact_settings(
&self
) -> UpdateEmergencyContactSettings
pub fn update_emergency_contact_settings(
&self
) -> UpdateEmergencyContactSettings
Constructs a fluent builder for the UpdateEmergencyContactSettings operation.
- The fluent builder is configurable:
emergency_contact_list(Vec<EmergencyContact>)/set_emergency_contact_list(Option<Vec<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.
- On success, responds with
UpdateEmergencyContactSettingsOutput - On failure, responds with
SdkError<UpdateEmergencyContactSettingsError>
sourcepub fn update_protection_group(&self) -> UpdateProtectionGroup
pub fn update_protection_group(&self) -> UpdateProtectionGroup
Constructs a fluent builder for the UpdateProtectionGroup operation.
- 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.
aggregation(ProtectionGroupAggregation)/set_aggregation(Option<ProtectionGroupAggregation>):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(ProtectionGroupPattern)/set_pattern(Option<ProtectionGroupPattern>):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(ProtectedResourceType)/set_resource_type(Option<ProtectedResourceType>):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
PatterntoBY_RESOURCE_TYPEand you must not set it for any otherPatternsetting.members(Vec<String>)/set_members(Option<Vec<String>>):The Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set
PatterntoARBITRARYand you must not set it for any otherPatternsetting.
- On success, responds with
UpdateProtectionGroupOutput - On failure, responds with
SdkError<UpdateProtectionGroupError>
sourcepub fn update_subscription(&self) -> UpdateSubscription
pub fn update_subscription(&self) -> UpdateSubscription
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,
AutoRenewis set toENABLED. IfENABLED, the subscription will be automatically renewed at the end of the existing subscription period. You can change this by submitting anUpdateSubscriptionrequest. If theUpdateSubscriptionrequest does not included a value forAutoRenew, the existing value forAutoRenewremains unchanged.
- On success, responds with
UpdateSubscriptionOutput - On failure, responds with
SdkError<UpdateSubscriptionError>
sourceimpl Client
impl Client
sourcepub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
pub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
Creates a client with the given service config and connector override.
Trait Implementations
sourceimpl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
sourcefn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
Converts to this type from the input type.
Auto Trait Implementations
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber to this type, returning a
WithDispatch wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
WithDispatch wrapper. Read more