/*
* Copyright 2012-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.shield;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.shield.model.*;
/**
* Interface for accessing AWS Shield.
* <p>
* <b>Note:</b> Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.shield.AbstractAWSShield} instead.
* </p>
* <p>
* <fullname>AWS Shield Advanced</fullname>
* <p>
* This is the <i>AWS Shield Advanced API Reference</i>. This guide is for developers who need detailed information
* about the AWS Shield Advanced API actions, data types, and errors. For detailed information about AWS WAF and AWS
* Shield Advanced features and an overview of how to use the AWS WAF and AWS Shield Advanced APIs, see the <a
* href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF and AWS Shield Developer Guide</a>.
* </p>
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSShield {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "shield";
/**
* Overrides the default endpoint for this client ("shield.us-east-1.amazonaws.com"). Callers can use this method to
* control which AWS region they want to work with.
* <p>
* Callers can pass in just the endpoint (ex: "shield.us-east-1.amazonaws.com") or a full URL, including the
* protocol (ex: "shield.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from
* this client's {@link ClientConfiguration} will be used, which by default is HTTPS.
* <p>
* For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available
* endpoints for all AWS services, see: <a
* href="http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912">
* http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912</a>
* <p>
* <b>This method is not threadsafe. An endpoint should be configured when the client is created and before any
* service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in
* transit or retrying.</b>
*
* @param endpoint
* The endpoint (ex: "shield.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
* "shield.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
* @deprecated use {@link AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)} for
* example:
* {@code builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));}
*/
@Deprecated
void setEndpoint(String endpoint);
/**
* An alternative to {@link AWSShield#setEndpoint(String)}, sets the regional endpoint for this client's service
* calls. Callers can use this method to control which AWS region they want to work with.
* <p>
* By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
* {@link ClientConfiguration} supplied at construction.
* <p>
* <b>This method is not threadsafe. A region should be configured when the client is created and before any service
* requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit
* or retrying.</b>
*
* @param region
* The region this client will communicate with. See {@link Region#getRegion(com.amazonaws.regions.Regions)}
* for accessing a given region. Must not be null and must be a region where the service is available.
*
* @see Region#getRegion(com.amazonaws.regions.Regions)
* @see Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
* @see Region#isServiceSupported(String)
* @deprecated use {@link AwsClientBuilder#setRegion(String)}
*/
@Deprecated
void setRegion(Region region);
/**
* <p>
* Enables AWS Shield Advanced for a specific AWS resource. The resource can be an Amazon CloudFront distribution,
* Elastic Load Balancing load balancer, or an Amazon Route 53 hosted zone.
* </p>
*
* @param createProtectionRequest
* @return Result of the CreateProtection operation returned by the service.
* @throws InternalErrorException
* Exception that indicates that a problem occurred with the service infrastructure. You can retry the
* request.
* @throws InvalidResourceException
* Exception that indicates that the resource is invalid. You might not have access to the resource, or the
* resource might not exist.
* @throws InvalidOperationException
* Exception that indicates that the operation would not cause any change to occur.
* @throws LimitsExceededException
* Exception that indicates that the operation would exceed a limit.
* @throws ResourceAlreadyExistsException
* Exception indicating the specified resource already exists.
* @throws OptimisticLockException
* Exception that indicates that the protection state has been modified by another client. You can retry the
* request.
* @throws ResourceNotFoundException
* Exception indicating the specified resource does not exist.
* @sample AWSShield.CreateProtection
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/CreateProtection" target="_top">AWS API
* Documentation</a>
*/
CreateProtectionResult createProtection(CreateProtectionRequest createProtectionRequest);
/**
* <p>
* Activates AWS Shield Advanced for an account.
* </p>
*
* @param createSubscriptionRequest
* @return Result of the CreateSubscription operation returned by the service.
* @throws InternalErrorException
* Exception that indicates that a problem occurred with the service infrastructure. You can retry the
* request.
* @throws ResourceAlreadyExistsException
* Exception indicating the specified resource already exists.
* @sample AWSShield.CreateSubscription
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/CreateSubscription" target="_top">AWS API
* Documentation</a>
*/
CreateSubscriptionResult createSubscription(CreateSubscriptionRequest createSubscriptionRequest);
/**
* <p>
* Deletes an AWS Shield Advanced <a>Protection</a>.
* </p>
*
* @param deleteProtectionRequest
* @return Result of the DeleteProtection operation returned by the service.
* @throws InternalErrorException
* Exception that indicates that a problem occurred with the service infrastructure. You can retry the
* request.
* @throws ResourceNotFoundException
* Exception indicating the specified resource does not exist.
* @throws OptimisticLockException
* Exception that indicates that the protection state has been modified by another client. You can retry the
* request.
* @sample AWSShield.DeleteProtection
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DeleteProtection" target="_top">AWS API
* Documentation</a>
*/
DeleteProtectionResult deleteProtection(DeleteProtectionRequest deleteProtectionRequest);
/**
* <p>
* Removes AWS Shield Advanced from an account.
* </p>
*
* @param deleteSubscriptionRequest
* @return Result of the DeleteSubscription operation returned by the service.
* @throws InternalErrorException
* Exception that indicates that a problem occurred with the service infrastructure. You can retry the
* request.
* @throws LockedSubscriptionException
* Exception that indicates that the subscription has been modified by another client. You can retry the
* request.
* @throws ResourceNotFoundException
* Exception indicating the specified resource does not exist.
* @sample AWSShield.DeleteSubscription
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DeleteSubscription" target="_top">AWS API
* Documentation</a>
*/
DeleteSubscriptionResult deleteSubscription(DeleteSubscriptionRequest deleteSubscriptionRequest);
/**
* <p>
* Describes the details of a DDoS attack.
* </p>
*
* @param describeAttackRequest
* @return Result of the DescribeAttack operation returned by the service.
* @throws InternalErrorException
* Exception that indicates that a problem occurred with the service infrastructure. You can retry the
* request.
* @throws InvalidParameterException
* Exception that indicates that the parameters passed to the API are invalid.
* @sample AWSShield.DescribeAttack
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DescribeAttack" target="_top">AWS API
* Documentation</a>
*/
DescribeAttackResult describeAttack(DescribeAttackRequest describeAttackRequest);
/**
* <p>
* Lists the details of a <a>Protection</a> object.
* </p>
*
* @param describeProtectionRequest
* @return Result of the DescribeProtection operation returned by the service.
* @throws InternalErrorException
* Exception that indicates that a problem occurred with the service infrastructure. You can retry the
* request.
* @throws ResourceNotFoundException
* Exception indicating the specified resource does not exist.
* @sample AWSShield.DescribeProtection
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DescribeProtection" target="_top">AWS API
* Documentation</a>
*/
DescribeProtectionResult describeProtection(DescribeProtectionRequest describeProtectionRequest);
/**
* <p>
* Provides details about the AWS Shield Advanced subscription for an account.
* </p>
*
* @param describeSubscriptionRequest
* @return Result of the DescribeSubscription operation returned by the service.
* @throws InternalErrorException
* Exception that indicates that a problem occurred with the service infrastructure. You can retry the
* request.
* @throws ResourceNotFoundException
* Exception indicating the specified resource does not exist.
* @sample AWSShield.DescribeSubscription
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DescribeSubscription" target="_top">AWS
* API Documentation</a>
*/
DescribeSubscriptionResult describeSubscription(DescribeSubscriptionRequest describeSubscriptionRequest);
/**
* <p>
* Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
* </p>
*
* @param listAttacksRequest
* @return Result of the ListAttacks operation returned by the service.
* @throws InternalErrorException
* Exception that indicates that a problem occurred with the service infrastructure. You can retry the
* request.
* @throws InvalidParameterException
* Exception that indicates that the parameters passed to the API are invalid.
* @throws InvalidOperationException
* Exception that indicates that the operation would not cause any change to occur.
* @sample AWSShield.ListAttacks
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/ListAttacks" target="_top">AWS API
* Documentation</a>
*/
ListAttacksResult listAttacks(ListAttacksRequest listAttacksRequest);
/**
* <p>
* Lists all <a>Protection</a> objects for the account.
* </p>
*
* @param listProtectionsRequest
* @return Result of the ListProtections operation returned by the service.
* @throws InternalErrorException
* Exception that indicates that a problem occurred with the service infrastructure. You can retry the
* request.
* @throws ResourceNotFoundException
* Exception indicating the specified resource does not exist.
* @sample AWSShield.ListProtections
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/ListProtections" target="_top">AWS API
* Documentation</a>
*/
ListProtectionsResult listProtections(ListProtectionsRequest listProtectionsRequest);
/**
* Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
* callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
* has been shutdown, it should not be used to make any more requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for debugging issues
* where a service isn't acting as expected. This data isn't considered part of the result data returned by an
* operation, so it's available through this separate, diagnostic interface.
* <p>
* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic
* information for an executed request, you should use this method to retrieve it as soon as possible after
* executing a request.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}