@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface ApplicationAutoScalingClient extends SdkClient
builder()
method.
With Application Auto Scaling, you can configure automatic scaling for the following resources:
Amazon ECS services
Amazon EC2 Spot Fleet requests
Amazon EMR clusters
Amazon AppStream 2.0 fleets
Amazon DynamoDB tables and global secondary indexes throughput capacity
Amazon Aurora Replicas
Amazon SageMaker endpoint variants
Custom resources provided by your own applications or services
Amazon Comprehend document classification and entity recognizer endpoints
AWS Lambda function provisioned concurrency
Amazon Keyspaces (for Apache Cassandra) tables
Amazon Managed Streaming for Apache Kafka broker storage
API Summary
The Application Auto Scaling service API includes three key sets of actions:
Register and manage scalable targets - Register AWS or custom resources as scalable targets (a resource that Application Auto Scaling can scale), set minimum and maximum capacity limits, and retrieve information on existing scalable targets.
Configure and manage automatic scaling - Define scaling policies to dynamically scale your resources in response to CloudWatch alarms, schedule one-time or recurring scaling actions, and retrieve your recent scaling activity history.
Suspend and resume scaling - Temporarily suspend and later resume automatic scaling by calling the RegisterScalableTarget API action for any Application Auto Scaling scalable target. You can suspend and resume (individually or in combination) scale-out activities that are triggered by a scaling policy, scale-in activities that are triggered by a scaling policy, and scheduled scaling.
To learn more about Application Auto Scaling, including information about granting IAM users required permissions for Application Auto Scaling actions, see the Application Auto Scaling User Guide.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static ApplicationAutoScalingClientBuilder |
builder()
Create a builder that can be used to configure and create a
ApplicationAutoScalingClient. |
static ApplicationAutoScalingClient |
create()
Create a
ApplicationAutoScalingClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default DeleteScalingPolicyResponse |
deleteScalingPolicy(Consumer<DeleteScalingPolicyRequest.Builder> deleteScalingPolicyRequest)
Deletes the specified scaling policy for an Application Auto Scaling scalable target.
|
default DeleteScalingPolicyResponse |
deleteScalingPolicy(DeleteScalingPolicyRequest deleteScalingPolicyRequest)
Deletes the specified scaling policy for an Application Auto Scaling scalable target.
|
default DeleteScheduledActionResponse |
deleteScheduledAction(Consumer<DeleteScheduledActionRequest.Builder> deleteScheduledActionRequest)
Deletes the specified scheduled action for an Application Auto Scaling scalable target.
|
default DeleteScheduledActionResponse |
deleteScheduledAction(DeleteScheduledActionRequest deleteScheduledActionRequest)
Deletes the specified scheduled action for an Application Auto Scaling scalable target.
|
default DeregisterScalableTargetResponse |
deregisterScalableTarget(Consumer<DeregisterScalableTargetRequest.Builder> deregisterScalableTargetRequest)
Deregisters an Application Auto Scaling scalable target when you have finished using it.
|
default DeregisterScalableTargetResponse |
deregisterScalableTarget(DeregisterScalableTargetRequest deregisterScalableTargetRequest)
Deregisters an Application Auto Scaling scalable target when you have finished using it.
|
default DescribeScalableTargetsResponse |
describeScalableTargets(Consumer<DescribeScalableTargetsRequest.Builder> describeScalableTargetsRequest)
Gets information about the scalable targets in the specified namespace.
|
default DescribeScalableTargetsResponse |
describeScalableTargets(DescribeScalableTargetsRequest describeScalableTargetsRequest)
Gets information about the scalable targets in the specified namespace.
|
default DescribeScalableTargetsIterable |
describeScalableTargetsPaginator(Consumer<DescribeScalableTargetsRequest.Builder> describeScalableTargetsRequest)
Gets information about the scalable targets in the specified namespace.
|
default DescribeScalableTargetsIterable |
describeScalableTargetsPaginator(DescribeScalableTargetsRequest describeScalableTargetsRequest)
Gets information about the scalable targets in the specified namespace.
|
default DescribeScalingActivitiesResponse |
describeScalingActivities(Consumer<DescribeScalingActivitiesRequest.Builder> describeScalingActivitiesRequest)
Provides descriptive information about the scaling activities in the specified namespace from the previous six
weeks.
|
default DescribeScalingActivitiesResponse |
describeScalingActivities(DescribeScalingActivitiesRequest describeScalingActivitiesRequest)
Provides descriptive information about the scaling activities in the specified namespace from the previous six
weeks.
|
default DescribeScalingActivitiesIterable |
describeScalingActivitiesPaginator(Consumer<DescribeScalingActivitiesRequest.Builder> describeScalingActivitiesRequest)
Provides descriptive information about the scaling activities in the specified namespace from the previous six
weeks.
|
default DescribeScalingActivitiesIterable |
describeScalingActivitiesPaginator(DescribeScalingActivitiesRequest describeScalingActivitiesRequest)
Provides descriptive information about the scaling activities in the specified namespace from the previous six
weeks.
|
default DescribeScalingPoliciesResponse |
describeScalingPolicies(Consumer<DescribeScalingPoliciesRequest.Builder> describeScalingPoliciesRequest)
Describes the Application Auto Scaling scaling policies for the specified service namespace.
|
default DescribeScalingPoliciesResponse |
describeScalingPolicies(DescribeScalingPoliciesRequest describeScalingPoliciesRequest)
Describes the Application Auto Scaling scaling policies for the specified service namespace.
|
default DescribeScalingPoliciesIterable |
describeScalingPoliciesPaginator(Consumer<DescribeScalingPoliciesRequest.Builder> describeScalingPoliciesRequest)
Describes the Application Auto Scaling scaling policies for the specified service namespace.
|
default DescribeScalingPoliciesIterable |
describeScalingPoliciesPaginator(DescribeScalingPoliciesRequest describeScalingPoliciesRequest)
Describes the Application Auto Scaling scaling policies for the specified service namespace.
|
default DescribeScheduledActionsResponse |
describeScheduledActions(Consumer<DescribeScheduledActionsRequest.Builder> describeScheduledActionsRequest)
Describes the Application Auto Scaling scheduled actions for the specified service namespace.
|
default DescribeScheduledActionsResponse |
describeScheduledActions(DescribeScheduledActionsRequest describeScheduledActionsRequest)
Describes the Application Auto Scaling scheduled actions for the specified service namespace.
|
default DescribeScheduledActionsIterable |
describeScheduledActionsPaginator(Consumer<DescribeScheduledActionsRequest.Builder> describeScheduledActionsRequest)
Describes the Application Auto Scaling scheduled actions for the specified service namespace.
|
default DescribeScheduledActionsIterable |
describeScheduledActionsPaginator(DescribeScheduledActionsRequest describeScheduledActionsRequest)
Describes the Application Auto Scaling scheduled actions for the specified service namespace.
|
default PutScalingPolicyResponse |
putScalingPolicy(Consumer<PutScalingPolicyRequest.Builder> putScalingPolicyRequest)
Creates or updates a scaling policy for an Application Auto Scaling scalable target.
|
default PutScalingPolicyResponse |
putScalingPolicy(PutScalingPolicyRequest putScalingPolicyRequest)
Creates or updates a scaling policy for an Application Auto Scaling scalable target.
|
default PutScheduledActionResponse |
putScheduledAction(Consumer<PutScheduledActionRequest.Builder> putScheduledActionRequest)
Creates or updates a scheduled action for an Application Auto Scaling scalable target.
|
default PutScheduledActionResponse |
putScheduledAction(PutScheduledActionRequest putScheduledActionRequest)
Creates or updates a scheduled action for an Application Auto Scaling scalable target.
|
default RegisterScalableTargetResponse |
registerScalableTarget(Consumer<RegisterScalableTargetRequest.Builder> registerScalableTargetRequest)
Registers or updates a scalable target.
|
default RegisterScalableTargetResponse |
registerScalableTarget(RegisterScalableTargetRequest registerScalableTargetRequest)
Registers or updates a scalable target.
|
static ServiceMetadata |
serviceMetadata() |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static ApplicationAutoScalingClient create()
ApplicationAutoScalingClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static ApplicationAutoScalingClientBuilder builder()
ApplicationAutoScalingClient.default DeleteScalingPolicyResponse deleteScalingPolicy(DeleteScalingPolicyRequest deleteScalingPolicyRequest) throws ValidationException, ObjectNotFoundException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, ApplicationAutoScalingException
Deletes the specified scaling policy for an Application Auto Scaling scalable target.
Deleting a step scaling policy deletes the underlying alarm action, but does not delete the CloudWatch alarm associated with the scaling policy, even if it no longer has an associated action.
For more information, see Delete a step scaling policy and Delete a target tracking scaling policy in the Application Auto Scaling User Guide.
deleteScalingPolicyRequest - ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.ObjectNotFoundException - The specified object could not be found. For any operation that depends on the existence of a scalable
target, this exception is thrown if the scalable target with the specified service namespace, resource
ID, and scalable dimension does not exist. For any operation that deletes or deregisters a resource, this
exception is thrown if the resource cannot be found.ConcurrentUpdateException - Concurrent updates caused an exception, for example, if you request an update to an Application Auto
Scaling resource that already has a pending update.InternalServiceException - The service encountered an internal error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ApplicationAutoScalingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteScalingPolicyResponse deleteScalingPolicy(Consumer<DeleteScalingPolicyRequest.Builder> deleteScalingPolicyRequest) throws ValidationException, ObjectNotFoundException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, ApplicationAutoScalingException
Deletes the specified scaling policy for an Application Auto Scaling scalable target.
Deleting a step scaling policy deletes the underlying alarm action, but does not delete the CloudWatch alarm associated with the scaling policy, even if it no longer has an associated action.
For more information, see Delete a step scaling policy and Delete a target tracking scaling policy in the Application Auto Scaling User Guide.
This is a convenience which creates an instance of the DeleteScalingPolicyRequest.Builder avoiding the
need to create one manually via DeleteScalingPolicyRequest.builder()
deleteScalingPolicyRequest - A Consumer that will call methods on DeleteScalingPolicyRequest.Builder to create a
request.ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.ObjectNotFoundException - The specified object could not be found. For any operation that depends on the existence of a scalable
target, this exception is thrown if the scalable target with the specified service namespace, resource
ID, and scalable dimension does not exist. For any operation that deletes or deregisters a resource, this
exception is thrown if the resource cannot be found.ConcurrentUpdateException - Concurrent updates caused an exception, for example, if you request an update to an Application Auto
Scaling resource that already has a pending update.InternalServiceException - The service encountered an internal error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ApplicationAutoScalingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteScheduledActionResponse deleteScheduledAction(DeleteScheduledActionRequest deleteScheduledActionRequest) throws ValidationException, ObjectNotFoundException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, ApplicationAutoScalingException
Deletes the specified scheduled action for an Application Auto Scaling scalable target.
For more information, see Delete a scheduled action in the Application Auto Scaling User Guide.
deleteScheduledActionRequest - ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.ObjectNotFoundException - The specified object could not be found. For any operation that depends on the existence of a scalable
target, this exception is thrown if the scalable target with the specified service namespace, resource
ID, and scalable dimension does not exist. For any operation that deletes or deregisters a resource, this
exception is thrown if the resource cannot be found.ConcurrentUpdateException - Concurrent updates caused an exception, for example, if you request an update to an Application Auto
Scaling resource that already has a pending update.InternalServiceException - The service encountered an internal error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ApplicationAutoScalingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteScheduledActionResponse deleteScheduledAction(Consumer<DeleteScheduledActionRequest.Builder> deleteScheduledActionRequest) throws ValidationException, ObjectNotFoundException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, ApplicationAutoScalingException
Deletes the specified scheduled action for an Application Auto Scaling scalable target.
For more information, see Delete a scheduled action in the Application Auto Scaling User Guide.
This is a convenience which creates an instance of the DeleteScheduledActionRequest.Builder avoiding the
need to create one manually via DeleteScheduledActionRequest.builder()
deleteScheduledActionRequest - A Consumer that will call methods on DeleteScheduledActionRequest.Builder to create a
request.ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.ObjectNotFoundException - The specified object could not be found. For any operation that depends on the existence of a scalable
target, this exception is thrown if the scalable target with the specified service namespace, resource
ID, and scalable dimension does not exist. For any operation that deletes or deregisters a resource, this
exception is thrown if the resource cannot be found.ConcurrentUpdateException - Concurrent updates caused an exception, for example, if you request an update to an Application Auto
Scaling resource that already has a pending update.InternalServiceException - The service encountered an internal error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ApplicationAutoScalingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeregisterScalableTargetResponse deregisterScalableTarget(DeregisterScalableTargetRequest deregisterScalableTargetRequest) throws ValidationException, ObjectNotFoundException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, ApplicationAutoScalingException
Deregisters an Application Auto Scaling scalable target when you have finished using it. To see which resources have been registered, use DescribeScalableTargets.
Deregistering a scalable target deletes the scaling policies and the scheduled actions that are associated with it.
deregisterScalableTargetRequest - ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.ObjectNotFoundException - The specified object could not be found. For any operation that depends on the existence of a scalable
target, this exception is thrown if the scalable target with the specified service namespace, resource
ID, and scalable dimension does not exist. For any operation that deletes or deregisters a resource, this
exception is thrown if the resource cannot be found.ConcurrentUpdateException - Concurrent updates caused an exception, for example, if you request an update to an Application Auto
Scaling resource that already has a pending update.InternalServiceException - The service encountered an internal error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ApplicationAutoScalingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeregisterScalableTargetResponse deregisterScalableTarget(Consumer<DeregisterScalableTargetRequest.Builder> deregisterScalableTargetRequest) throws ValidationException, ObjectNotFoundException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, ApplicationAutoScalingException
Deregisters an Application Auto Scaling scalable target when you have finished using it. To see which resources have been registered, use DescribeScalableTargets.
Deregistering a scalable target deletes the scaling policies and the scheduled actions that are associated with it.
This is a convenience which creates an instance of the DeregisterScalableTargetRequest.Builder avoiding
the need to create one manually via DeregisterScalableTargetRequest.builder()
deregisterScalableTargetRequest - A Consumer that will call methods on DeregisterScalableTargetRequest.Builder to create a
request.ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.ObjectNotFoundException - The specified object could not be found. For any operation that depends on the existence of a scalable
target, this exception is thrown if the scalable target with the specified service namespace, resource
ID, and scalable dimension does not exist. For any operation that deletes or deregisters a resource, this
exception is thrown if the resource cannot be found.ConcurrentUpdateException - Concurrent updates caused an exception, for example, if you request an update to an Application Auto
Scaling resource that already has a pending update.InternalServiceException - The service encountered an internal error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ApplicationAutoScalingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeScalableTargetsResponse describeScalableTargets(DescribeScalableTargetsRequest describeScalableTargetsRequest) throws ValidationException, InvalidNextTokenException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, ApplicationAutoScalingException
Gets information about the scalable targets in the specified namespace.
You can filter the results using ResourceIds and ScalableDimension.
describeScalableTargetsRequest - ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.InvalidNextTokenException - The next token supplied was invalid.ConcurrentUpdateException - Concurrent updates caused an exception, for example, if you request an update to an Application Auto
Scaling resource that already has a pending update.InternalServiceException - The service encountered an internal error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ApplicationAutoScalingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeScalableTargetsResponse describeScalableTargets(Consumer<DescribeScalableTargetsRequest.Builder> describeScalableTargetsRequest) throws ValidationException, InvalidNextTokenException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, ApplicationAutoScalingException
Gets information about the scalable targets in the specified namespace.
You can filter the results using ResourceIds and ScalableDimension.
This is a convenience which creates an instance of the DescribeScalableTargetsRequest.Builder avoiding
the need to create one manually via DescribeScalableTargetsRequest.builder()
describeScalableTargetsRequest - A Consumer that will call methods on DescribeScalableTargetsRequest.Builder to create a
request.ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.InvalidNextTokenException - The next token supplied was invalid.ConcurrentUpdateException - Concurrent updates caused an exception, for example, if you request an update to an Application Auto
Scaling resource that already has a pending update.InternalServiceException - The service encountered an internal error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ApplicationAutoScalingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeScalableTargetsIterable describeScalableTargetsPaginator(DescribeScalableTargetsRequest describeScalableTargetsRequest) throws ValidationException, InvalidNextTokenException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, ApplicationAutoScalingException
Gets information about the scalable targets in the specified namespace.
You can filter the results using ResourceIds and ScalableDimension.
This is a variant of
describeScalableTargets(software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalableTargetsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalableTargetsIterable responses = client.describeScalableTargetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalableTargetsIterable responses = client
.describeScalableTargetsPaginator(request);
for (software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalableTargetsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalableTargetsIterable responses = client.describeScalableTargetsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeScalableTargets(software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalableTargetsRequest)
operation.
describeScalableTargetsRequest - ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.InvalidNextTokenException - The next token supplied was invalid.ConcurrentUpdateException - Concurrent updates caused an exception, for example, if you request an update to an Application Auto
Scaling resource that already has a pending update.InternalServiceException - The service encountered an internal error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ApplicationAutoScalingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeScalableTargetsIterable describeScalableTargetsPaginator(Consumer<DescribeScalableTargetsRequest.Builder> describeScalableTargetsRequest) throws ValidationException, InvalidNextTokenException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, ApplicationAutoScalingException
Gets information about the scalable targets in the specified namespace.
You can filter the results using ResourceIds and ScalableDimension.
This is a variant of
describeScalableTargets(software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalableTargetsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalableTargetsIterable responses = client.describeScalableTargetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalableTargetsIterable responses = client
.describeScalableTargetsPaginator(request);
for (software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalableTargetsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalableTargetsIterable responses = client.describeScalableTargetsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeScalableTargets(software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalableTargetsRequest)
operation.
This is a convenience which creates an instance of the DescribeScalableTargetsRequest.Builder avoiding
the need to create one manually via DescribeScalableTargetsRequest.builder()
describeScalableTargetsRequest - A Consumer that will call methods on DescribeScalableTargetsRequest.Builder to create a
request.ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.InvalidNextTokenException - The next token supplied was invalid.ConcurrentUpdateException - Concurrent updates caused an exception, for example, if you request an update to an Application Auto
Scaling resource that already has a pending update.InternalServiceException - The service encountered an internal error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ApplicationAutoScalingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeScalingActivitiesResponse describeScalingActivities(DescribeScalingActivitiesRequest describeScalingActivitiesRequest) throws ValidationException, InvalidNextTokenException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, ApplicationAutoScalingException
Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks.
You can filter the results using ResourceId and ScalableDimension.
describeScalingActivitiesRequest - ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.InvalidNextTokenException - The next token supplied was invalid.ConcurrentUpdateException - Concurrent updates caused an exception, for example, if you request an update to an Application Auto
Scaling resource that already has a pending update.InternalServiceException - The service encountered an internal error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ApplicationAutoScalingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeScalingActivitiesResponse describeScalingActivities(Consumer<DescribeScalingActivitiesRequest.Builder> describeScalingActivitiesRequest) throws ValidationException, InvalidNextTokenException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, ApplicationAutoScalingException
Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks.
You can filter the results using ResourceId and ScalableDimension.
This is a convenience which creates an instance of the DescribeScalingActivitiesRequest.Builder avoiding
the need to create one manually via DescribeScalingActivitiesRequest.builder()
describeScalingActivitiesRequest - A Consumer that will call methods on DescribeScalingActivitiesRequest.Builder to create a
request.ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.InvalidNextTokenException - The next token supplied was invalid.ConcurrentUpdateException - Concurrent updates caused an exception, for example, if you request an update to an Application Auto
Scaling resource that already has a pending update.InternalServiceException - The service encountered an internal error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ApplicationAutoScalingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeScalingActivitiesIterable describeScalingActivitiesPaginator(DescribeScalingActivitiesRequest describeScalingActivitiesRequest) throws ValidationException, InvalidNextTokenException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, ApplicationAutoScalingException
Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks.
You can filter the results using ResourceId and ScalableDimension.
This is a variant of
describeScalingActivities(software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalingActivitiesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalingActivitiesIterable responses = client.describeScalingActivitiesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalingActivitiesIterable responses = client
.describeScalingActivitiesPaginator(request);
for (software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalingActivitiesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalingActivitiesIterable responses = client.describeScalingActivitiesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeScalingActivities(software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalingActivitiesRequest)
operation.
describeScalingActivitiesRequest - ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.InvalidNextTokenException - The next token supplied was invalid.ConcurrentUpdateException - Concurrent updates caused an exception, for example, if you request an update to an Application Auto
Scaling resource that already has a pending update.InternalServiceException - The service encountered an internal error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ApplicationAutoScalingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeScalingActivitiesIterable describeScalingActivitiesPaginator(Consumer<DescribeScalingActivitiesRequest.Builder> describeScalingActivitiesRequest) throws ValidationException, InvalidNextTokenException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, ApplicationAutoScalingException
Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks.
You can filter the results using ResourceId and ScalableDimension.
This is a variant of
describeScalingActivities(software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalingActivitiesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalingActivitiesIterable responses = client.describeScalingActivitiesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalingActivitiesIterable responses = client
.describeScalingActivitiesPaginator(request);
for (software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalingActivitiesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalingActivitiesIterable responses = client.describeScalingActivitiesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeScalingActivities(software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalingActivitiesRequest)
operation.
This is a convenience which creates an instance of the DescribeScalingActivitiesRequest.Builder avoiding
the need to create one manually via DescribeScalingActivitiesRequest.builder()
describeScalingActivitiesRequest - A Consumer that will call methods on DescribeScalingActivitiesRequest.Builder to create a
request.ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.InvalidNextTokenException - The next token supplied was invalid.ConcurrentUpdateException - Concurrent updates caused an exception, for example, if you request an update to an Application Auto
Scaling resource that already has a pending update.InternalServiceException - The service encountered an internal error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ApplicationAutoScalingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeScalingPoliciesResponse describeScalingPolicies(DescribeScalingPoliciesRequest describeScalingPoliciesRequest) throws ValidationException, FailedResourceAccessException, InvalidNextTokenException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, ApplicationAutoScalingException
Describes the Application Auto Scaling scaling policies for the specified service namespace.
You can filter the results using ResourceId, ScalableDimension, and
PolicyNames.
For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.
describeScalingPoliciesRequest - ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.FailedResourceAccessException - Failed access to resources caused an exception. This exception is thrown when Application Auto Scaling is
unable to retrieve the alarms associated with a scaling policy due to a client error, for example, if the
role ARN specified for a scalable target does not have permission to call the CloudWatch DescribeAlarms on your behalf.InvalidNextTokenException - The next token supplied was invalid.ConcurrentUpdateException - Concurrent updates caused an exception, for example, if you request an update to an Application Auto
Scaling resource that already has a pending update.InternalServiceException - The service encountered an internal error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ApplicationAutoScalingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeScalingPoliciesResponse describeScalingPolicies(Consumer<DescribeScalingPoliciesRequest.Builder> describeScalingPoliciesRequest) throws ValidationException, FailedResourceAccessException, InvalidNextTokenException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, ApplicationAutoScalingException
Describes the Application Auto Scaling scaling policies for the specified service namespace.
You can filter the results using ResourceId, ScalableDimension, and
PolicyNames.
For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.
This is a convenience which creates an instance of the DescribeScalingPoliciesRequest.Builder avoiding
the need to create one manually via DescribeScalingPoliciesRequest.builder()
describeScalingPoliciesRequest - A Consumer that will call methods on DescribeScalingPoliciesRequest.Builder to create a
request.ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.FailedResourceAccessException - Failed access to resources caused an exception. This exception is thrown when Application Auto Scaling is
unable to retrieve the alarms associated with a scaling policy due to a client error, for example, if the
role ARN specified for a scalable target does not have permission to call the CloudWatch DescribeAlarms on your behalf.InvalidNextTokenException - The next token supplied was invalid.ConcurrentUpdateException - Concurrent updates caused an exception, for example, if you request an update to an Application Auto
Scaling resource that already has a pending update.InternalServiceException - The service encountered an internal error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ApplicationAutoScalingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeScalingPoliciesIterable describeScalingPoliciesPaginator(DescribeScalingPoliciesRequest describeScalingPoliciesRequest) throws ValidationException, FailedResourceAccessException, InvalidNextTokenException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, ApplicationAutoScalingException
Describes the Application Auto Scaling scaling policies for the specified service namespace.
You can filter the results using ResourceId, ScalableDimension, and
PolicyNames.
For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.
This is a variant of
describeScalingPolicies(software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalingPoliciesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalingPoliciesIterable responses = client.describeScalingPoliciesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalingPoliciesIterable responses = client
.describeScalingPoliciesPaginator(request);
for (software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalingPoliciesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalingPoliciesIterable responses = client.describeScalingPoliciesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeScalingPolicies(software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalingPoliciesRequest)
operation.
describeScalingPoliciesRequest - ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.FailedResourceAccessException - Failed access to resources caused an exception. This exception is thrown when Application Auto Scaling is
unable to retrieve the alarms associated with a scaling policy due to a client error, for example, if the
role ARN specified for a scalable target does not have permission to call the CloudWatch DescribeAlarms on your behalf.InvalidNextTokenException - The next token supplied was invalid.ConcurrentUpdateException - Concurrent updates caused an exception, for example, if you request an update to an Application Auto
Scaling resource that already has a pending update.InternalServiceException - The service encountered an internal error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ApplicationAutoScalingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeScalingPoliciesIterable describeScalingPoliciesPaginator(Consumer<DescribeScalingPoliciesRequest.Builder> describeScalingPoliciesRequest) throws ValidationException, FailedResourceAccessException, InvalidNextTokenException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, ApplicationAutoScalingException
Describes the Application Auto Scaling scaling policies for the specified service namespace.
You can filter the results using ResourceId, ScalableDimension, and
PolicyNames.
For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.
This is a variant of
describeScalingPolicies(software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalingPoliciesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalingPoliciesIterable responses = client.describeScalingPoliciesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalingPoliciesIterable responses = client
.describeScalingPoliciesPaginator(request);
for (software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalingPoliciesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalingPoliciesIterable responses = client.describeScalingPoliciesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeScalingPolicies(software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalingPoliciesRequest)
operation.
This is a convenience which creates an instance of the DescribeScalingPoliciesRequest.Builder avoiding
the need to create one manually via DescribeScalingPoliciesRequest.builder()
describeScalingPoliciesRequest - A Consumer that will call methods on DescribeScalingPoliciesRequest.Builder to create a
request.ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.FailedResourceAccessException - Failed access to resources caused an exception. This exception is thrown when Application Auto Scaling is
unable to retrieve the alarms associated with a scaling policy due to a client error, for example, if the
role ARN specified for a scalable target does not have permission to call the CloudWatch DescribeAlarms on your behalf.InvalidNextTokenException - The next token supplied was invalid.ConcurrentUpdateException - Concurrent updates caused an exception, for example, if you request an update to an Application Auto
Scaling resource that already has a pending update.InternalServiceException - The service encountered an internal error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ApplicationAutoScalingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeScheduledActionsResponse describeScheduledActions(DescribeScheduledActionsRequest describeScheduledActionsRequest) throws ValidationException, InvalidNextTokenException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, ApplicationAutoScalingException
Describes the Application Auto Scaling scheduled actions for the specified service namespace.
You can filter the results using the ResourceId, ScalableDimension, and
ScheduledActionNames parameters.
For more information, see Scheduled scaling and Managing scheduled scaling in the Application Auto Scaling User Guide.
describeScheduledActionsRequest - ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.InvalidNextTokenException - The next token supplied was invalid.ConcurrentUpdateException - Concurrent updates caused an exception, for example, if you request an update to an Application Auto
Scaling resource that already has a pending update.InternalServiceException - The service encountered an internal error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ApplicationAutoScalingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeScheduledActionsResponse describeScheduledActions(Consumer<DescribeScheduledActionsRequest.Builder> describeScheduledActionsRequest) throws ValidationException, InvalidNextTokenException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, ApplicationAutoScalingException
Describes the Application Auto Scaling scheduled actions for the specified service namespace.
You can filter the results using the ResourceId, ScalableDimension, and
ScheduledActionNames parameters.
For more information, see Scheduled scaling and Managing scheduled scaling in the Application Auto Scaling User Guide.
This is a convenience which creates an instance of the DescribeScheduledActionsRequest.Builder avoiding
the need to create one manually via DescribeScheduledActionsRequest.builder()
describeScheduledActionsRequest - A Consumer that will call methods on DescribeScheduledActionsRequest.Builder to create a
request.ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.InvalidNextTokenException - The next token supplied was invalid.ConcurrentUpdateException - Concurrent updates caused an exception, for example, if you request an update to an Application Auto
Scaling resource that already has a pending update.InternalServiceException - The service encountered an internal error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ApplicationAutoScalingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeScheduledActionsIterable describeScheduledActionsPaginator(DescribeScheduledActionsRequest describeScheduledActionsRequest) throws ValidationException, InvalidNextTokenException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, ApplicationAutoScalingException
Describes the Application Auto Scaling scheduled actions for the specified service namespace.
You can filter the results using the ResourceId, ScalableDimension, and
ScheduledActionNames parameters.
For more information, see Scheduled scaling and Managing scheduled scaling in the Application Auto Scaling User Guide.
This is a variant of
describeScheduledActions(software.amazon.awssdk.services.applicationautoscaling.model.DescribeScheduledActionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScheduledActionsIterable responses = client.describeScheduledActionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScheduledActionsIterable responses = client
.describeScheduledActionsPaginator(request);
for (software.amazon.awssdk.services.applicationautoscaling.model.DescribeScheduledActionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScheduledActionsIterable responses = client.describeScheduledActionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeScheduledActions(software.amazon.awssdk.services.applicationautoscaling.model.DescribeScheduledActionsRequest)
operation.
describeScheduledActionsRequest - ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.InvalidNextTokenException - The next token supplied was invalid.ConcurrentUpdateException - Concurrent updates caused an exception, for example, if you request an update to an Application Auto
Scaling resource that already has a pending update.InternalServiceException - The service encountered an internal error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ApplicationAutoScalingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeScheduledActionsIterable describeScheduledActionsPaginator(Consumer<DescribeScheduledActionsRequest.Builder> describeScheduledActionsRequest) throws ValidationException, InvalidNextTokenException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, ApplicationAutoScalingException
Describes the Application Auto Scaling scheduled actions for the specified service namespace.
You can filter the results using the ResourceId, ScalableDimension, and
ScheduledActionNames parameters.
For more information, see Scheduled scaling and Managing scheduled scaling in the Application Auto Scaling User Guide.
This is a variant of
describeScheduledActions(software.amazon.awssdk.services.applicationautoscaling.model.DescribeScheduledActionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScheduledActionsIterable responses = client.describeScheduledActionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScheduledActionsIterable responses = client
.describeScheduledActionsPaginator(request);
for (software.amazon.awssdk.services.applicationautoscaling.model.DescribeScheduledActionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScheduledActionsIterable responses = client.describeScheduledActionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeScheduledActions(software.amazon.awssdk.services.applicationautoscaling.model.DescribeScheduledActionsRequest)
operation.
This is a convenience which creates an instance of the DescribeScheduledActionsRequest.Builder avoiding
the need to create one manually via DescribeScheduledActionsRequest.builder()
describeScheduledActionsRequest - A Consumer that will call methods on DescribeScheduledActionsRequest.Builder to create a
request.ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.InvalidNextTokenException - The next token supplied was invalid.ConcurrentUpdateException - Concurrent updates caused an exception, for example, if you request an update to an Application Auto
Scaling resource that already has a pending update.InternalServiceException - The service encountered an internal error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ApplicationAutoScalingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutScalingPolicyResponse putScalingPolicy(PutScalingPolicyRequest putScalingPolicyRequest) throws ValidationException, LimitExceededException, ObjectNotFoundException, ConcurrentUpdateException, FailedResourceAccessException, InternalServiceException, AwsServiceException, SdkClientException, ApplicationAutoScalingException
Creates or updates a scaling policy for an Application Auto Scaling scalable target.
Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scaling policy applies to the scalable target identified by those three attributes. You cannot create a scaling policy until you have registered the resource as a scalable target.
Multiple scaling policies can be in force at the same time for the same scalable target. You can have one or more target tracking scaling policies, one or more step scaling policies, or both. However, there is a chance that multiple policies could conflict, instructing the scalable target to scale out or in at the same time. Application Auto Scaling gives precedence to the policy that provides the largest capacity for both scale out and scale in. For example, if one policy increases capacity by 3, another policy increases capacity by 200 percent, and the current capacity is 10, Application Auto Scaling uses the policy with the highest calculated capacity (200% of 10 = 20) and scales out to 30.
We recommend caution, however, when using target tracking scaling policies with step scaling policies because conflicts between these policies can cause undesirable behavior. For example, if the step scaling policy initiates a scale-in activity before the target tracking policy is ready to scale in, the scale-in activity will not be blocked. After the scale-in activity completes, the target tracking policy could instruct the scalable target to scale out again.
For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.
If a scalable target is deregistered, the scalable target is no longer available to execute scaling policies. Any scaling policies that were specified for the scalable target are deleted.
putScalingPolicyRequest - ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.LimitExceededException - A per-account resource limit is exceeded. For more information, see Application Auto Scaling service quotas.ObjectNotFoundException - The specified object could not be found. For any operation that depends on the existence of a scalable
target, this exception is thrown if the scalable target with the specified service namespace, resource
ID, and scalable dimension does not exist. For any operation that deletes or deregisters a resource, this
exception is thrown if the resource cannot be found.ConcurrentUpdateException - Concurrent updates caused an exception, for example, if you request an update to an Application Auto
Scaling resource that already has a pending update.FailedResourceAccessException - Failed access to resources caused an exception. This exception is thrown when Application Auto Scaling is
unable to retrieve the alarms associated with a scaling policy due to a client error, for example, if the
role ARN specified for a scalable target does not have permission to call the CloudWatch DescribeAlarms on your behalf.InternalServiceException - The service encountered an internal error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ApplicationAutoScalingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutScalingPolicyResponse putScalingPolicy(Consumer<PutScalingPolicyRequest.Builder> putScalingPolicyRequest) throws ValidationException, LimitExceededException, ObjectNotFoundException, ConcurrentUpdateException, FailedResourceAccessException, InternalServiceException, AwsServiceException, SdkClientException, ApplicationAutoScalingException
Creates or updates a scaling policy for an Application Auto Scaling scalable target.
Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scaling policy applies to the scalable target identified by those three attributes. You cannot create a scaling policy until you have registered the resource as a scalable target.
Multiple scaling policies can be in force at the same time for the same scalable target. You can have one or more target tracking scaling policies, one or more step scaling policies, or both. However, there is a chance that multiple policies could conflict, instructing the scalable target to scale out or in at the same time. Application Auto Scaling gives precedence to the policy that provides the largest capacity for both scale out and scale in. For example, if one policy increases capacity by 3, another policy increases capacity by 200 percent, and the current capacity is 10, Application Auto Scaling uses the policy with the highest calculated capacity (200% of 10 = 20) and scales out to 30.
We recommend caution, however, when using target tracking scaling policies with step scaling policies because conflicts between these policies can cause undesirable behavior. For example, if the step scaling policy initiates a scale-in activity before the target tracking policy is ready to scale in, the scale-in activity will not be blocked. After the scale-in activity completes, the target tracking policy could instruct the scalable target to scale out again.
For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.
If a scalable target is deregistered, the scalable target is no longer available to execute scaling policies. Any scaling policies that were specified for the scalable target are deleted.
This is a convenience which creates an instance of the PutScalingPolicyRequest.Builder avoiding the need
to create one manually via PutScalingPolicyRequest.builder()
putScalingPolicyRequest - A Consumer that will call methods on PutScalingPolicyRequest.Builder to create a request.ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.LimitExceededException - A per-account resource limit is exceeded. For more information, see Application Auto Scaling service quotas.ObjectNotFoundException - The specified object could not be found. For any operation that depends on the existence of a scalable
target, this exception is thrown if the scalable target with the specified service namespace, resource
ID, and scalable dimension does not exist. For any operation that deletes or deregisters a resource, this
exception is thrown if the resource cannot be found.ConcurrentUpdateException - Concurrent updates caused an exception, for example, if you request an update to an Application Auto
Scaling resource that already has a pending update.FailedResourceAccessException - Failed access to resources caused an exception. This exception is thrown when Application Auto Scaling is
unable to retrieve the alarms associated with a scaling policy due to a client error, for example, if the
role ARN specified for a scalable target does not have permission to call the CloudWatch DescribeAlarms on your behalf.InternalServiceException - The service encountered an internal error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ApplicationAutoScalingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutScheduledActionResponse putScheduledAction(PutScheduledActionRequest putScheduledActionRequest) throws ValidationException, LimitExceededException, ObjectNotFoundException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, ApplicationAutoScalingException
Creates or updates a scheduled action for an Application Auto Scaling scalable target.
Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scheduled action applies to the scalable target identified by those three attributes. You cannot create a scheduled action until you have registered the resource as a scalable target.
When start and end times are specified with a recurring schedule using a cron expression or rates, they form the boundaries for when the recurring action starts and stops.
To update a scheduled action, specify the parameters that you want to change. If you don't specify start and end times, the old values are deleted.
For more information, see Scheduled scaling in the Application Auto Scaling User Guide.
If a scalable target is deregistered, the scalable target is no longer available to run scheduled actions. Any scheduled actions that were specified for the scalable target are deleted.
putScheduledActionRequest - ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.LimitExceededException - A per-account resource limit is exceeded. For more information, see Application Auto Scaling service quotas.ObjectNotFoundException - The specified object could not be found. For any operation that depends on the existence of a scalable
target, this exception is thrown if the scalable target with the specified service namespace, resource
ID, and scalable dimension does not exist. For any operation that deletes or deregisters a resource, this
exception is thrown if the resource cannot be found.ConcurrentUpdateException - Concurrent updates caused an exception, for example, if you request an update to an Application Auto
Scaling resource that already has a pending update.InternalServiceException - The service encountered an internal error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ApplicationAutoScalingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutScheduledActionResponse putScheduledAction(Consumer<PutScheduledActionRequest.Builder> putScheduledActionRequest) throws ValidationException, LimitExceededException, ObjectNotFoundException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, ApplicationAutoScalingException
Creates or updates a scheduled action for an Application Auto Scaling scalable target.
Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scheduled action applies to the scalable target identified by those three attributes. You cannot create a scheduled action until you have registered the resource as a scalable target.
When start and end times are specified with a recurring schedule using a cron expression or rates, they form the boundaries for when the recurring action starts and stops.
To update a scheduled action, specify the parameters that you want to change. If you don't specify start and end times, the old values are deleted.
For more information, see Scheduled scaling in the Application Auto Scaling User Guide.
If a scalable target is deregistered, the scalable target is no longer available to run scheduled actions. Any scheduled actions that were specified for the scalable target are deleted.
This is a convenience which creates an instance of the PutScheduledActionRequest.Builder avoiding the
need to create one manually via PutScheduledActionRequest.builder()
putScheduledActionRequest - A Consumer that will call methods on PutScheduledActionRequest.Builder to create a
request.ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.LimitExceededException - A per-account resource limit is exceeded. For more information, see Application Auto Scaling service quotas.ObjectNotFoundException - The specified object could not be found. For any operation that depends on the existence of a scalable
target, this exception is thrown if the scalable target with the specified service namespace, resource
ID, and scalable dimension does not exist. For any operation that deletes or deregisters a resource, this
exception is thrown if the resource cannot be found.ConcurrentUpdateException - Concurrent updates caused an exception, for example, if you request an update to an Application Auto
Scaling resource that already has a pending update.InternalServiceException - The service encountered an internal error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ApplicationAutoScalingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RegisterScalableTargetResponse registerScalableTarget(RegisterScalableTargetRequest registerScalableTargetRequest) throws ValidationException, LimitExceededException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, ApplicationAutoScalingException
Registers or updates a scalable target.
A scalable target is a resource that Application Auto Scaling can scale out and scale in. Scalable targets are uniquely identified by the combination of resource ID, scalable dimension, and namespace.
When you register a new scalable target, you must specify values for minimum and maximum capacity. Current capacity will be adjusted within the specified range when scaling starts. Application Auto Scaling scaling policies will not scale capacity to values that are outside of this range.
After you register a scalable target, you do not need to register it again to use other Application Auto Scaling operations. To see which resources have been registered, use DescribeScalableTargets. You can also view the scaling policies for a service namespace by using DescribeScalableTargets. If you no longer need a scalable target, you can deregister it by using DeregisterScalableTarget.
To update a scalable target, specify the parameters that you want to change. Include the parameters that identify the scalable target: resource ID, scalable dimension, and namespace. Any parameters that you don't specify are not changed by this update request.
registerScalableTargetRequest - ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.LimitExceededException - A per-account resource limit is exceeded. For more information, see Application Auto Scaling service quotas.ConcurrentUpdateException - Concurrent updates caused an exception, for example, if you request an update to an Application Auto
Scaling resource that already has a pending update.InternalServiceException - The service encountered an internal error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ApplicationAutoScalingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RegisterScalableTargetResponse registerScalableTarget(Consumer<RegisterScalableTargetRequest.Builder> registerScalableTargetRequest) throws ValidationException, LimitExceededException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, ApplicationAutoScalingException
Registers or updates a scalable target.
A scalable target is a resource that Application Auto Scaling can scale out and scale in. Scalable targets are uniquely identified by the combination of resource ID, scalable dimension, and namespace.
When you register a new scalable target, you must specify values for minimum and maximum capacity. Current capacity will be adjusted within the specified range when scaling starts. Application Auto Scaling scaling policies will not scale capacity to values that are outside of this range.
After you register a scalable target, you do not need to register it again to use other Application Auto Scaling operations. To see which resources have been registered, use DescribeScalableTargets. You can also view the scaling policies for a service namespace by using DescribeScalableTargets. If you no longer need a scalable target, you can deregister it by using DeregisterScalableTarget.
To update a scalable target, specify the parameters that you want to change. Include the parameters that identify the scalable target: resource ID, scalable dimension, and namespace. Any parameters that you don't specify are not changed by this update request.
This is a convenience which creates an instance of the RegisterScalableTargetRequest.Builder avoiding the
need to create one manually via RegisterScalableTargetRequest.builder()
registerScalableTargetRequest - A Consumer that will call methods on RegisterScalableTargetRequest.Builder to create a
request.ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.LimitExceededException - A per-account resource limit is exceeded. For more information, see Application Auto Scaling service quotas.ConcurrentUpdateException - Concurrent updates caused an exception, for example, if you request an update to an Application Auto
Scaling resource that already has a pending update.InternalServiceException - The service encountered an internal error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ApplicationAutoScalingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2021. All rights reserved.