All Downloads are FREE. Search and download functionalities are using the official Maven repository.

software.amazon.awssdk.services.autoscalingplans.AutoScalingPlansClient Maven / Gradle / Ivy

Go to download

The AWS Java SDK for Auto Scaling Plans module holds the client classes that are used for communicating with Auto Scaling Plans.

There is a newer version: 2.28.4
Show newest version
/*
 * Copyright 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 software.amazon.awssdk.services.autoscalingplans;

import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.awscore.AwsClient;
import software.amazon.awssdk.awscore.exception.AwsServiceException;
import software.amazon.awssdk.core.exception.SdkClientException;
import software.amazon.awssdk.regions.ServiceMetadata;
import software.amazon.awssdk.services.autoscalingplans.model.AutoScalingPlansException;
import software.amazon.awssdk.services.autoscalingplans.model.ConcurrentUpdateException;
import software.amazon.awssdk.services.autoscalingplans.model.CreateScalingPlanRequest;
import software.amazon.awssdk.services.autoscalingplans.model.CreateScalingPlanResponse;
import software.amazon.awssdk.services.autoscalingplans.model.DeleteScalingPlanRequest;
import software.amazon.awssdk.services.autoscalingplans.model.DeleteScalingPlanResponse;
import software.amazon.awssdk.services.autoscalingplans.model.DescribeScalingPlanResourcesRequest;
import software.amazon.awssdk.services.autoscalingplans.model.DescribeScalingPlanResourcesResponse;
import software.amazon.awssdk.services.autoscalingplans.model.DescribeScalingPlansRequest;
import software.amazon.awssdk.services.autoscalingplans.model.DescribeScalingPlansResponse;
import software.amazon.awssdk.services.autoscalingplans.model.GetScalingPlanResourceForecastDataRequest;
import software.amazon.awssdk.services.autoscalingplans.model.GetScalingPlanResourceForecastDataResponse;
import software.amazon.awssdk.services.autoscalingplans.model.InternalServiceException;
import software.amazon.awssdk.services.autoscalingplans.model.InvalidNextTokenException;
import software.amazon.awssdk.services.autoscalingplans.model.LimitExceededException;
import software.amazon.awssdk.services.autoscalingplans.model.ObjectNotFoundException;
import software.amazon.awssdk.services.autoscalingplans.model.UpdateScalingPlanRequest;
import software.amazon.awssdk.services.autoscalingplans.model.UpdateScalingPlanResponse;
import software.amazon.awssdk.services.autoscalingplans.model.ValidationException;

/**
 * Service client for accessing AWS Auto Scaling Plans. This can be created using the static {@link #builder()} method.
 *
 * AWS Auto Scaling
 * 

* Use AWS Auto Scaling to create scaling plans for your applications to automatically scale your scalable AWS * resources. *

*

* API Summary *

*

* You can use the AWS Auto Scaling service API to accomplish the following tasks: *

*
    *
  • *

    * Create and manage scaling plans *

    *
  • *
  • *

    * Define target tracking scaling policies to dynamically scale your resources based on utilization *

    *
  • *
  • *

    * Scale Amazon EC2 Auto Scaling groups using predictive scaling and dynamic scaling to scale your Amazon EC2 capacity * faster *

    *
  • *
  • *

    * Set minimum and maximum capacity limits *

    *
  • *
  • *

    * Retrieve information on existing scaling plans *

    *
  • *
  • *

    * Access current forecast data and historical forecast data for up to 56 days previous *

    *
  • *
*

* To learn more about AWS Auto Scaling, including information about granting IAM users required permissions for AWS * Auto Scaling actions, see the AWS Auto Scaling User * Guide. *

*/ @Generated("software.amazon.awssdk:codegen") @SdkPublicApi @ThreadSafe public interface AutoScalingPlansClient extends AwsClient { String SERVICE_NAME = "autoscaling-plans"; /** * Value for looking up the service's metadata from the * {@link software.amazon.awssdk.regions.ServiceMetadataProvider}. */ String SERVICE_METADATA_ID = "autoscaling-plans"; /** *

* Creates a scaling plan. *

* * @param createScalingPlanRequest * @return Result of the CreateScalingPlan operation returned by the service. * @throws ValidationException * An exception was thrown for a validation issue. Review the parameters provided. * @throws LimitExceededException * Your account exceeded a limit. This exception is thrown when a per-account resource limit is exceeded. * @throws ConcurrentUpdateException * Concurrent updates caused an exception, for example, if you request an update to a scaling plan that * already has a pending update. * @throws InternalServiceException * The service encountered an internal error. * @throws SdkException * Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for * catch all scenarios. * @throws SdkClientException * If any client side error occurs such as an IO related failure, failure to get credentials, etc. * @throws AutoScalingPlansException * Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type. * @sample AutoScalingPlansClient.CreateScalingPlan * @see AWS API Documentation */ default CreateScalingPlanResponse createScalingPlan(CreateScalingPlanRequest createScalingPlanRequest) throws ValidationException, LimitExceededException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, AutoScalingPlansException { throw new UnsupportedOperationException(); } /** *

* Creates a scaling plan. *

*
*

* This is a convenience which creates an instance of the {@link CreateScalingPlanRequest.Builder} avoiding the need * to create one manually via {@link CreateScalingPlanRequest#builder()} *

* * @param createScalingPlanRequest * A {@link Consumer} that will call methods on * {@link software.amazon.awssdk.services.autoscalingplans.model.CreateScalingPlanRequest.Builder} to create * a request. * @return Result of the CreateScalingPlan operation returned by the service. * @throws ValidationException * An exception was thrown for a validation issue. Review the parameters provided. * @throws LimitExceededException * Your account exceeded a limit. This exception is thrown when a per-account resource limit is exceeded. * @throws ConcurrentUpdateException * Concurrent updates caused an exception, for example, if you request an update to a scaling plan that * already has a pending update. * @throws InternalServiceException * The service encountered an internal error. * @throws SdkException * Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for * catch all scenarios. * @throws SdkClientException * If any client side error occurs such as an IO related failure, failure to get credentials, etc. * @throws AutoScalingPlansException * Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type. * @sample AutoScalingPlansClient.CreateScalingPlan * @see AWS API Documentation */ default CreateScalingPlanResponse createScalingPlan(Consumer createScalingPlanRequest) throws ValidationException, LimitExceededException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, AutoScalingPlansException { return createScalingPlan(CreateScalingPlanRequest.builder().applyMutation(createScalingPlanRequest).build()); } /** *

* Deletes the specified scaling plan. *

*

* Deleting a scaling plan deletes the underlying ScalingInstruction for all of the scalable resources that * are covered by the plan. *

*

* If the plan has launched resources or has scaling activities in progress, you must delete those resources * separately. *

* * @param deleteScalingPlanRequest * @return Result of the DeleteScalingPlan operation returned by the service. * @throws ValidationException * An exception was thrown for a validation issue. Review the parameters provided. * @throws ObjectNotFoundException * The specified object could not be found. * @throws ConcurrentUpdateException * Concurrent updates caused an exception, for example, if you request an update to a scaling plan that * already has a pending update. * @throws InternalServiceException * The service encountered an internal error. * @throws SdkException * Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for * catch all scenarios. * @throws SdkClientException * If any client side error occurs such as an IO related failure, failure to get credentials, etc. * @throws AutoScalingPlansException * Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type. * @sample AutoScalingPlansClient.DeleteScalingPlan * @see AWS API Documentation */ default DeleteScalingPlanResponse deleteScalingPlan(DeleteScalingPlanRequest deleteScalingPlanRequest) throws ValidationException, ObjectNotFoundException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, AutoScalingPlansException { throw new UnsupportedOperationException(); } /** *

* Deletes the specified scaling plan. *

*

* Deleting a scaling plan deletes the underlying ScalingInstruction for all of the scalable resources that * are covered by the plan. *

*

* If the plan has launched resources or has scaling activities in progress, you must delete those resources * separately. *

*
*

* This is a convenience which creates an instance of the {@link DeleteScalingPlanRequest.Builder} avoiding the need * to create one manually via {@link DeleteScalingPlanRequest#builder()} *

* * @param deleteScalingPlanRequest * A {@link Consumer} that will call methods on * {@link software.amazon.awssdk.services.autoscalingplans.model.DeleteScalingPlanRequest.Builder} to create * a request. * @return Result of the DeleteScalingPlan operation returned by the service. * @throws ValidationException * An exception was thrown for a validation issue. Review the parameters provided. * @throws ObjectNotFoundException * The specified object could not be found. * @throws ConcurrentUpdateException * Concurrent updates caused an exception, for example, if you request an update to a scaling plan that * already has a pending update. * @throws InternalServiceException * The service encountered an internal error. * @throws SdkException * Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for * catch all scenarios. * @throws SdkClientException * If any client side error occurs such as an IO related failure, failure to get credentials, etc. * @throws AutoScalingPlansException * Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type. * @sample AutoScalingPlansClient.DeleteScalingPlan * @see AWS API Documentation */ default DeleteScalingPlanResponse deleteScalingPlan(Consumer deleteScalingPlanRequest) throws ValidationException, ObjectNotFoundException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, AutoScalingPlansException { return deleteScalingPlan(DeleteScalingPlanRequest.builder().applyMutation(deleteScalingPlanRequest).build()); } /** *

* Describes the scalable resources in the specified scaling plan. *

* * @param describeScalingPlanResourcesRequest * @return Result of the DescribeScalingPlanResources operation returned by the service. * @throws ValidationException * An exception was thrown for a validation issue. Review the parameters provided. * @throws InvalidNextTokenException * The token provided is not valid. * @throws ConcurrentUpdateException * Concurrent updates caused an exception, for example, if you request an update to a scaling plan that * already has a pending update. * @throws InternalServiceException * The service encountered an internal error. * @throws SdkException * Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for * catch all scenarios. * @throws SdkClientException * If any client side error occurs such as an IO related failure, failure to get credentials, etc. * @throws AutoScalingPlansException * Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type. * @sample AutoScalingPlansClient.DescribeScalingPlanResources * @see AWS API Documentation */ default DescribeScalingPlanResourcesResponse describeScalingPlanResources( DescribeScalingPlanResourcesRequest describeScalingPlanResourcesRequest) throws ValidationException, InvalidNextTokenException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, AutoScalingPlansException { throw new UnsupportedOperationException(); } /** *

* Describes the scalable resources in the specified scaling plan. *

*
*

* This is a convenience which creates an instance of the {@link DescribeScalingPlanResourcesRequest.Builder} * avoiding the need to create one manually via {@link DescribeScalingPlanResourcesRequest#builder()} *

* * @param describeScalingPlanResourcesRequest * A {@link Consumer} that will call methods on * {@link software.amazon.awssdk.services.autoscalingplans.model.DescribeScalingPlanResourcesRequest.Builder} * to create a request. * @return Result of the DescribeScalingPlanResources operation returned by the service. * @throws ValidationException * An exception was thrown for a validation issue. Review the parameters provided. * @throws InvalidNextTokenException * The token provided is not valid. * @throws ConcurrentUpdateException * Concurrent updates caused an exception, for example, if you request an update to a scaling plan that * already has a pending update. * @throws InternalServiceException * The service encountered an internal error. * @throws SdkException * Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for * catch all scenarios. * @throws SdkClientException * If any client side error occurs such as an IO related failure, failure to get credentials, etc. * @throws AutoScalingPlansException * Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type. * @sample AutoScalingPlansClient.DescribeScalingPlanResources * @see AWS API Documentation */ default DescribeScalingPlanResourcesResponse describeScalingPlanResources( Consumer describeScalingPlanResourcesRequest) throws ValidationException, InvalidNextTokenException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, AutoScalingPlansException { return describeScalingPlanResources(DescribeScalingPlanResourcesRequest.builder() .applyMutation(describeScalingPlanResourcesRequest).build()); } /** *

* Describes one or more of your scaling plans. *

* * @param describeScalingPlansRequest * @return Result of the DescribeScalingPlans operation returned by the service. * @throws ValidationException * An exception was thrown for a validation issue. Review the parameters provided. * @throws InvalidNextTokenException * The token provided is not valid. * @throws ConcurrentUpdateException * Concurrent updates caused an exception, for example, if you request an update to a scaling plan that * already has a pending update. * @throws InternalServiceException * The service encountered an internal error. * @throws SdkException * Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for * catch all scenarios. * @throws SdkClientException * If any client side error occurs such as an IO related failure, failure to get credentials, etc. * @throws AutoScalingPlansException * Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type. * @sample AutoScalingPlansClient.DescribeScalingPlans * @see AWS API Documentation */ default DescribeScalingPlansResponse describeScalingPlans(DescribeScalingPlansRequest describeScalingPlansRequest) throws ValidationException, InvalidNextTokenException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, AutoScalingPlansException { throw new UnsupportedOperationException(); } /** *

* Describes one or more of your scaling plans. *

*
*

* This is a convenience which creates an instance of the {@link DescribeScalingPlansRequest.Builder} avoiding the * need to create one manually via {@link DescribeScalingPlansRequest#builder()} *

* * @param describeScalingPlansRequest * A {@link Consumer} that will call methods on * {@link software.amazon.awssdk.services.autoscalingplans.model.DescribeScalingPlansRequest.Builder} to * create a request. * @return Result of the DescribeScalingPlans operation returned by the service. * @throws ValidationException * An exception was thrown for a validation issue. Review the parameters provided. * @throws InvalidNextTokenException * The token provided is not valid. * @throws ConcurrentUpdateException * Concurrent updates caused an exception, for example, if you request an update to a scaling plan that * already has a pending update. * @throws InternalServiceException * The service encountered an internal error. * @throws SdkException * Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for * catch all scenarios. * @throws SdkClientException * If any client side error occurs such as an IO related failure, failure to get credentials, etc. * @throws AutoScalingPlansException * Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type. * @sample AutoScalingPlansClient.DescribeScalingPlans * @see AWS API Documentation */ default DescribeScalingPlansResponse describeScalingPlans( Consumer describeScalingPlansRequest) throws ValidationException, InvalidNextTokenException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, AutoScalingPlansException { return describeScalingPlans(DescribeScalingPlansRequest.builder().applyMutation(describeScalingPlansRequest).build()); } /** *

* Describes one or more of your scaling plans. *

* * @return Result of the DescribeScalingPlans operation returned by the service. * @throws ValidationException * An exception was thrown for a validation issue. Review the parameters provided. * @throws InvalidNextTokenException * The token provided is not valid. * @throws ConcurrentUpdateException * Concurrent updates caused an exception, for example, if you request an update to a scaling plan that * already has a pending update. * @throws InternalServiceException * The service encountered an internal error. * @throws SdkException * Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for * catch all scenarios. * @throws SdkClientException * If any client side error occurs such as an IO related failure, failure to get credentials, etc. * @throws AutoScalingPlansException * Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type. * @sample AutoScalingPlansClient.DescribeScalingPlans * @see #describeScalingPlans(DescribeScalingPlansRequest) * @see AWS API Documentation */ default DescribeScalingPlansResponse describeScalingPlans() throws ValidationException, InvalidNextTokenException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, AutoScalingPlansException { return describeScalingPlans(DescribeScalingPlansRequest.builder().build()); } /** *

* Retrieves the forecast data for a scalable resource. *

*

* Capacity forecasts are represented as predicted values, or data points, that are calculated using historical data * points from a specified CloudWatch load metric. Data points are available for up to 56 days. *

* * @param getScalingPlanResourceForecastDataRequest * @return Result of the GetScalingPlanResourceForecastData operation returned by the service. * @throws ValidationException * An exception was thrown for a validation issue. Review the parameters provided. * @throws InternalServiceException * The service encountered an internal error. * @throws SdkException * Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for * catch all scenarios. * @throws SdkClientException * If any client side error occurs such as an IO related failure, failure to get credentials, etc. * @throws AutoScalingPlansException * Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type. * @sample AutoScalingPlansClient.GetScalingPlanResourceForecastData * @see AWS API Documentation */ default GetScalingPlanResourceForecastDataResponse getScalingPlanResourceForecastData( GetScalingPlanResourceForecastDataRequest getScalingPlanResourceForecastDataRequest) throws ValidationException, InternalServiceException, AwsServiceException, SdkClientException, AutoScalingPlansException { throw new UnsupportedOperationException(); } /** *

* Retrieves the forecast data for a scalable resource. *

*

* Capacity forecasts are represented as predicted values, or data points, that are calculated using historical data * points from a specified CloudWatch load metric. Data points are available for up to 56 days. *

*
*

* This is a convenience which creates an instance of the {@link GetScalingPlanResourceForecastDataRequest.Builder} * avoiding the need to create one manually via {@link GetScalingPlanResourceForecastDataRequest#builder()} *

* * @param getScalingPlanResourceForecastDataRequest * A {@link Consumer} that will call methods on * {@link software.amazon.awssdk.services.autoscalingplans.model.GetScalingPlanResourceForecastDataRequest.Builder} * to create a request. * @return Result of the GetScalingPlanResourceForecastData operation returned by the service. * @throws ValidationException * An exception was thrown for a validation issue. Review the parameters provided. * @throws InternalServiceException * The service encountered an internal error. * @throws SdkException * Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for * catch all scenarios. * @throws SdkClientException * If any client side error occurs such as an IO related failure, failure to get credentials, etc. * @throws AutoScalingPlansException * Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type. * @sample AutoScalingPlansClient.GetScalingPlanResourceForecastData * @see AWS API Documentation */ default GetScalingPlanResourceForecastDataResponse getScalingPlanResourceForecastData( Consumer getScalingPlanResourceForecastDataRequest) throws ValidationException, InternalServiceException, AwsServiceException, SdkClientException, AutoScalingPlansException { return getScalingPlanResourceForecastData(GetScalingPlanResourceForecastDataRequest.builder() .applyMutation(getScalingPlanResourceForecastDataRequest).build()); } /** *

* Updates the specified scaling plan. *

*

* You cannot update a scaling plan if it is in the process of being created, updated, or deleted. *

* * @param updateScalingPlanRequest * @return Result of the UpdateScalingPlan operation returned by the service. * @throws ValidationException * An exception was thrown for a validation issue. Review the parameters provided. * @throws ConcurrentUpdateException * Concurrent updates caused an exception, for example, if you request an update to a scaling plan that * already has a pending update. * @throws InternalServiceException * The service encountered an internal error. * @throws ObjectNotFoundException * The specified object could not be found. * @throws SdkException * Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for * catch all scenarios. * @throws SdkClientException * If any client side error occurs such as an IO related failure, failure to get credentials, etc. * @throws AutoScalingPlansException * Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type. * @sample AutoScalingPlansClient.UpdateScalingPlan * @see AWS API Documentation */ default UpdateScalingPlanResponse updateScalingPlan(UpdateScalingPlanRequest updateScalingPlanRequest) throws ValidationException, ConcurrentUpdateException, InternalServiceException, ObjectNotFoundException, AwsServiceException, SdkClientException, AutoScalingPlansException { throw new UnsupportedOperationException(); } /** *

* Updates the specified scaling plan. *

*

* You cannot update a scaling plan if it is in the process of being created, updated, or deleted. *

*
*

* This is a convenience which creates an instance of the {@link UpdateScalingPlanRequest.Builder} avoiding the need * to create one manually via {@link UpdateScalingPlanRequest#builder()} *

* * @param updateScalingPlanRequest * A {@link Consumer} that will call methods on * {@link software.amazon.awssdk.services.autoscalingplans.model.UpdateScalingPlanRequest.Builder} to create * a request. * @return Result of the UpdateScalingPlan operation returned by the service. * @throws ValidationException * An exception was thrown for a validation issue. Review the parameters provided. * @throws ConcurrentUpdateException * Concurrent updates caused an exception, for example, if you request an update to a scaling plan that * already has a pending update. * @throws InternalServiceException * The service encountered an internal error. * @throws ObjectNotFoundException * The specified object could not be found. * @throws SdkException * Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for * catch all scenarios. * @throws SdkClientException * If any client side error occurs such as an IO related failure, failure to get credentials, etc. * @throws AutoScalingPlansException * Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type. * @sample AutoScalingPlansClient.UpdateScalingPlan * @see AWS API Documentation */ default UpdateScalingPlanResponse updateScalingPlan(Consumer updateScalingPlanRequest) throws ValidationException, ConcurrentUpdateException, InternalServiceException, ObjectNotFoundException, AwsServiceException, SdkClientException, AutoScalingPlansException { return updateScalingPlan(UpdateScalingPlanRequest.builder().applyMutation(updateScalingPlanRequest).build()); } /** * Create a {@link AutoScalingPlansClient} with the region loaded from the * {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the * {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}. */ static AutoScalingPlansClient create() { return builder().build(); } /** * Create a builder that can be used to configure and create a {@link AutoScalingPlansClient}. */ static AutoScalingPlansClientBuilder builder() { return new DefaultAutoScalingPlansClientBuilder(); } static ServiceMetadata serviceMetadata() { return ServiceMetadata.of(SERVICE_METADATA_ID); } @Override default AutoScalingPlansServiceClientConfiguration serviceClientConfiguration() { throw new UnsupportedOperationException(); } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy