com.amazonaws.services.autoscaling

クラス AmazonAutoScalingClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.autoscaling.AmazonAutoScalingClient

すべての実装されたインタフェース:

AmazonAutoScaling

直系の既知のサブクラス:

AmazonAutoScalingAsyncClient

public class AmazonAutoScalingClient
extends AmazonWebServiceClient
implements AmazonAutoScaling

Client for accessing AmazonAutoScaling. All service calls made using this client are blocking, and will not return until the service call completes.

Auto Scaling

This guide provides detailed information about Auto Scaling actions, data types, parameters, and errors. For detailed information about Auto Scaling features and their associated API calls, go to the Auto Scaling Developer Guide .

Auto Scaling is a web service designed to automatically launch or terminate Amazon Elastic Compute Cloud (Amazon EC2) instances based on user-defined policies, schedules, and health checks. This service is used in conjunction with Amazon CloudWatch and Elastic Load Balancing services.

This reference is based on the current WSDL, which is available at:

http://autoscaling.amazonaws.com/doc/2011-01-01/AutoScaling.wsdl

Endpoints

For information about this product's regions and endpoints, go to Regions and Endpoints in the Amazon Web Services General Reference.

フィールドの概要

フィールド

修飾子とタイプ	フィールドと説明
protected java.util.List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,org.w3c.dom.Node>>	exceptionUnmarshallers List of exception unmarshallers for all AmazonAutoScaling exceptions.

クラスから継承されたフィールド com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, requestHandlers, timeOffset, version

コンストラクタの概要

コンストラクタ

コンストラクタと説明
AmazonAutoScalingClient() Constructs a new client to invoke service methods on AmazonAutoScaling.
AmazonAutoScalingClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AmazonAutoScaling using the specified AWS account credentials.
AmazonAutoScalingClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonAutoScaling using the specified AWS account credentials and client configuration options.
AmazonAutoScalingClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AmazonAutoScaling using the specified AWS account credentials provider.
AmazonAutoScalingClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonAutoScaling using the specified AWS account credentials provider and client configuration options.
AmazonAutoScalingClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonAutoScaling.

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
void	createAutoScalingGroup(CreateAutoScalingGroupRequest createAutoScalingGroupRequest) Creates a new Auto Scaling group with the specified name and other attributes.
void	createLaunchConfiguration(CreateLaunchConfigurationRequest createLaunchConfigurationRequest) Creates a new launch configuration.
void	createOrUpdateTags(CreateOrUpdateTagsRequest createOrUpdateTagsRequest) Creates new tags or updates existing tags for an Auto Scaling group.
void	deleteAutoScalingGroup(DeleteAutoScalingGroupRequest deleteAutoScalingGroupRequest) Deletes the specified Auto Scaling group if the group has no instances and no scaling activities in progress.
void	deleteLaunchConfiguration(DeleteLaunchConfigurationRequest deleteLaunchConfigurationRequest) Deletes the specified LaunchConfiguration.
void	deleteNotificationConfiguration(DeleteNotificationConfigurationRequest deleteNotificationConfigurationRequest) Deletes notifications created by PutNotificationConfiguration.
void	deletePolicy(DeletePolicyRequest deletePolicyRequest) Deletes a policy created by PutScalingPolicy.
void	deleteScheduledAction(DeleteScheduledActionRequest deleteScheduledActionRequest) Deletes a scheduled action previously created using the PutScheduledUpdateGroupAction.
void	deleteTags(DeleteTagsRequest deleteTagsRequest) Removes the specified tags or a set of tags from a set of resources.
DescribeAdjustmentTypesResult	describeAdjustmentTypes() Returns policy adjustment types for use in the PutScalingPolicy action.
DescribeAdjustmentTypesResult	describeAdjustmentTypes(DescribeAdjustmentTypesRequest describeAdjustmentTypesRequest) Returns policy adjustment types for use in the PutScalingPolicy action.
DescribeAutoScalingGroupsResult	describeAutoScalingGroups() Returns a full description of each Auto Scaling group in the given list.
DescribeAutoScalingGroupsResult	describeAutoScalingGroups(DescribeAutoScalingGroupsRequest describeAutoScalingGroupsRequest) Returns a full description of each Auto Scaling group in the given list.
DescribeAutoScalingInstancesResult	describeAutoScalingInstances() Returns a description of each Auto Scaling instance in the InstanceIds list.
DescribeAutoScalingInstancesResult	describeAutoScalingInstances(DescribeAutoScalingInstancesRequest describeAutoScalingInstancesRequest) Returns a description of each Auto Scaling instance in the InstanceIds list.
DescribeAutoScalingNotificationTypesResult	describeAutoScalingNotificationTypes() Returns a list of all notification types that are supported by Auto Scaling.
DescribeAutoScalingNotificationTypesResult	describeAutoScalingNotificationTypes(DescribeAutoScalingNotificationTypesRequest describeAutoScalingNotificationTypesRequest) Returns a list of all notification types that are supported by Auto Scaling.
DescribeLaunchConfigurationsResult	describeLaunchConfigurations() Returns a full description of the launch configurations, or the specified launch configurations, if they exist.
DescribeLaunchConfigurationsResult	describeLaunchConfigurations(DescribeLaunchConfigurationsRequest describeLaunchConfigurationsRequest) Returns a full description of the launch configurations, or the specified launch configurations, if they exist.
DescribeMetricCollectionTypesResult	describeMetricCollectionTypes() Returns a list of metrics and a corresponding list of granularities for each metric.
DescribeMetricCollectionTypesResult	describeMetricCollectionTypes(DescribeMetricCollectionTypesRequest describeMetricCollectionTypesRequest) Returns a list of metrics and a corresponding list of granularities for each metric.
DescribeNotificationConfigurationsResult	describeNotificationConfigurations() Returns a list of notification actions associated with Auto Scaling groups for specified events.
DescribeNotificationConfigurationsResult	describeNotificationConfigurations(DescribeNotificationConfigurationsRequest describeNotificationConfigurationsRequest) Returns a list of notification actions associated with Auto Scaling groups for specified events.
DescribePoliciesResult	describePolicies() Returns descriptions of what each policy does.
DescribePoliciesResult	describePolicies(DescribePoliciesRequest describePoliciesRequest) Returns descriptions of what each policy does.
DescribeScalingActivitiesResult	describeScalingActivities() Returns the scaling activities for the specified Auto Scaling group.
DescribeScalingActivitiesResult	describeScalingActivities(DescribeScalingActivitiesRequest describeScalingActivitiesRequest) Returns the scaling activities for the specified Auto Scaling group.
DescribeScalingProcessTypesResult	describeScalingProcessTypes() Returns scaling process types for use in the ResumeProcesses and SuspendProcesses actions.
DescribeScalingProcessTypesResult	describeScalingProcessTypes(DescribeScalingProcessTypesRequest describeScalingProcessTypesRequest) Returns scaling process types for use in the ResumeProcesses and SuspendProcesses actions.
DescribeScheduledActionsResult	describeScheduledActions() Lists all the actions scheduled for your Auto Scaling group that haven't been executed.
DescribeScheduledActionsResult	describeScheduledActions(DescribeScheduledActionsRequest describeScheduledActionsRequest) Lists all the actions scheduled for your Auto Scaling group that haven't been executed.
DescribeTagsResult	describeTags() Lists the Auto Scaling group tags.
DescribeTagsResult	describeTags(DescribeTagsRequest describeTagsRequest) Lists the Auto Scaling group tags.
DescribeTerminationPolicyTypesResult	describeTerminationPolicyTypes() Returns a list of all termination policies supported by Auto Scaling.
DescribeTerminationPolicyTypesResult	describeTerminationPolicyTypes(DescribeTerminationPolicyTypesRequest describeTerminationPolicyTypesRequest) Returns a list of all termination policies supported by Auto Scaling.
void	disableMetricsCollection(DisableMetricsCollectionRequest disableMetricsCollectionRequest) Disables monitoring of group metrics for the Auto Scaling group specified in AutoScalingGroupName .
void	enableMetricsCollection(EnableMetricsCollectionRequest enableMetricsCollectionRequest) Enables monitoring of group metrics for the Auto Scaling group specified in AutoScalingGroupName .
void	executePolicy(ExecutePolicyRequest executePolicyRequest) Runs the policy you create for your Auto Scaling group in PutScalingPolicy.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
protected java.lang.String	getServiceAbbreviation() リージョンによるサービスエンドポイントを特定するために、このサービスに対する 略称を返します
void	putNotificationConfiguration(PutNotificationConfigurationRequest putNotificationConfigurationRequest) Configures an Auto Scaling group to send notifications when specified events take place.
PutScalingPolicyResult	putScalingPolicy(PutScalingPolicyRequest putScalingPolicyRequest) Creates or updates a policy for an Auto Scaling group.
void	putScheduledUpdateGroupAction(PutScheduledUpdateGroupActionRequest putScheduledUpdateGroupActionRequest) Creates a scheduled scaling action for an Auto Scaling group.
void	resumeProcesses(ResumeProcessesRequest resumeProcessesRequest) Resumes Auto Scaling processes for an Auto Scaling group.
void	setDesiredCapacity(SetDesiredCapacityRequest setDesiredCapacityRequest) Adjusts the desired size of the AutoScalingGroup by initiating scaling activities.
void	setEndpoint(java.lang.String endpoint, java.lang.String serviceName, java.lang.String regionId) Overrides the default endpoint for this client ("https://autoscaling.amazonaws.com") and explicitly provides an AWS region ID and AWS service name to use when the client calculates a signature for requests.
void	setInstanceHealth(SetInstanceHealthRequest setInstanceHealthRequest) Sets the health status of an instance.
void	suspendProcesses(SuspendProcessesRequest suspendProcessesRequest) Suspends Auto Scaling processes for an Auto Scaling group.
TerminateInstanceInAutoScalingGroupResult	terminateInstanceInAutoScalingGroup(TerminateInstanceInAutoScalingGroupRequest terminateInstanceInAutoScalingGroupRequest) Terminates the specified instance.
void	updateAutoScalingGroup(UpdateAutoScalingGroupRequest updateAutoScalingGroupRequest) Updates the configuration for the specified AutoScalingGroup.

クラスから継承されたメソッド com.amazonaws.AmazonWebServiceClient

addRequestHandler, convertToHttpRequest, createExecutionContext, getTimeOffset, getVersion, removeRequestHandler, setConfiguration, setEndpoint, setRegion, setTimeOffset, setVersion, shutdown, withTimeOffset

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

インタフェースから継承されたメソッド com.amazonaws.services.autoscaling.AmazonAutoScaling

setEndpoint, setRegion, shutdown

フィールドの詳細

exceptionUnmarshallers

protected final java.util.List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,org.w3c.dom.Node>> exceptionUnmarshallers

List of exception unmarshallers for all AmazonAutoScaling exceptions.

コンストラクタの詳細

AmazonAutoScalingClient

public AmazonAutoScalingClient()

Constructs a new client to invoke service methods on AmazonAutoScaling. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

関連項目:

DefaultAWSCredentialsProvider

AmazonAutoScalingClient

public AmazonAutoScalingClient(ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonAutoScaling. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

パラメータ:

clientConfiguration - The client configuration options controlling how this client connects to AmazonAutoScaling (ex: proxy settings, retry counts, etc.).

関連項目:

DefaultAWSCredentialsProvider

AmazonAutoScalingClient

public AmazonAutoScalingClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AmazonAutoScaling using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

パラメータ:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonAutoScalingClient

public AmazonAutoScalingClient(AWSCredentials awsCredentials,
                       ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonAutoScaling using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

パラメータ:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonAutoScaling (ex: proxy settings, retry counts, etc.).

AmazonAutoScalingClient

public AmazonAutoScalingClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AmazonAutoScaling using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

パラメータ:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonAutoScalingClient

public AmazonAutoScalingClient(AWSCredentialsProvider awsCredentialsProvider,
                       ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonAutoScaling using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

パラメータ:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonAutoScaling (ex: proxy settings, retry counts, etc.).

メソッドの詳細

describeAutoScalingGroups

public DescribeAutoScalingGroupsResult describeAutoScalingGroups(DescribeAutoScalingGroupsRequest describeAutoScalingGroupsRequest)
                                                          throws AmazonServiceException,
                                                                 AmazonClientException

Returns a full description of each Auto Scaling group in the given list. This includes all Amazon EC2 instances that are members of the group. If a list of names is not provided, the service returns the full details of all Auto Scaling groups.

This action supports pagination by returning a token if there are more pages to retrieve. To get the next page, call this action again with the returned token as the NextToken parameter.

定義:

describeAutoScalingGroups インタフェース内 AmazonAutoScaling

パラメータ:

describeAutoScalingGroupsRequest - Container for the necessary parameters to execute the DescribeAutoScalingGroups service method on AmazonAutoScaling.

戻り値:

The response from the DescribeAutoScalingGroups service method, as returned by AmazonAutoScaling.

例外:

InvalidNextTokenException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

enableMetricsCollection

public void enableMetricsCollection(EnableMetricsCollectionRequest enableMetricsCollectionRequest)
                             throws AmazonServiceException,
                                    AmazonClientException

Enables monitoring of group metrics for the Auto Scaling group specified in AutoScalingGroupName . You can specify the list of enabled metrics with the Metrics parameter.

Auto scaling metrics collection can be turned on only if the InstanceMonitoring flag, in the Auto Scaling group's launch configuration, is set to True .

定義:

enableMetricsCollection インタフェース内 AmazonAutoScaling

パラメータ:

enableMetricsCollectionRequest - Container for the necessary parameters to execute the EnableMetricsCollection service method on AmazonAutoScaling.

例外:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

resumeProcesses

public void resumeProcesses(ResumeProcessesRequest resumeProcessesRequest)
                     throws AmazonServiceException,
                            AmazonClientException

Resumes Auto Scaling processes for an Auto Scaling group. For more information, see SuspendProcesses and ProcessType.

定義:

resumeProcesses インタフェース内 AmazonAutoScaling

パラメータ:

resumeProcessesRequest - Container for the necessary parameters to execute the ResumeProcesses service method on AmazonAutoScaling.

例外:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

deleteLaunchConfiguration

public void deleteLaunchConfiguration(DeleteLaunchConfigurationRequest deleteLaunchConfigurationRequest)
                               throws AmazonServiceException,
                                      AmazonClientException

Deletes the specified LaunchConfiguration.

The specified launch configuration must not be attached to an Auto Scaling group. When this call completes, the launch configuration is no longer available for use.

定義:

deleteLaunchConfiguration インタフェース内 AmazonAutoScaling

パラメータ:

deleteLaunchConfigurationRequest - Container for the necessary parameters to execute the DeleteLaunchConfiguration service method on AmazonAutoScaling.

例外:

ResourceInUseException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describePolicies

public DescribePoliciesResult describePolicies(DescribePoliciesRequest describePoliciesRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

Returns descriptions of what each policy does. This action supports pagination. If the response includes a token, there are more records available. To get the additional records, repeat the request with the response token as the NextToken parameter.

定義:

describePolicies インタフェース内 AmazonAutoScaling

パラメータ:

describePoliciesRequest - Container for the necessary parameters to execute the DescribePolicies service method on AmazonAutoScaling.

戻り値:

The response from the DescribePolicies service method, as returned by AmazonAutoScaling.

例外:

InvalidNextTokenException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeScalingProcessTypes

public DescribeScalingProcessTypesResult describeScalingProcessTypes(DescribeScalingProcessTypesRequest describeScalingProcessTypesRequest)
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

Returns scaling process types for use in the ResumeProcesses and SuspendProcesses actions.

定義:

describeScalingProcessTypes インタフェース内 AmazonAutoScaling

パラメータ:

describeScalingProcessTypesRequest - Container for the necessary parameters to execute the DescribeScalingProcessTypes service method on AmazonAutoScaling.

戻り値:

The response from the DescribeScalingProcessTypes service method, as returned by AmazonAutoScaling.

例外:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

createAutoScalingGroup

public void createAutoScalingGroup(CreateAutoScalingGroupRequest createAutoScalingGroupRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Creates a new Auto Scaling group with the specified name and other attributes. When the creation request is completed, the Auto Scaling group is ready to be used in other calls.

NOTE: The Auto Scaling group name must be unique within the scope of your AWS account, and under the quota of Auto Scaling groups allowed for your account.

定義:

createAutoScalingGroup インタフェース内 AmazonAutoScaling

パラメータ:

createAutoScalingGroupRequest - Container for the necessary parameters to execute the CreateAutoScalingGroup service method on AmazonAutoScaling.

例外:

LimitExceededException

AlreadyExistsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeScalingActivities

public DescribeScalingActivitiesResult describeScalingActivities(DescribeScalingActivitiesRequest describeScalingActivitiesRequest)
                                                          throws AmazonServiceException,
                                                                 AmazonClientException

Returns the scaling activities for the specified Auto Scaling group.

If the specified ActivityIds list is empty, all the activities from the past six weeks are returned. Activities are sorted by completion time. Activities still in progress appear first on the list.

This action supports pagination. If the response includes a token, there are more records available. To get the additional records, repeat the request with the response token as the NextToken parameter.

定義:

describeScalingActivities インタフェース内 AmazonAutoScaling

パラメータ:

describeScalingActivitiesRequest - Container for the necessary parameters to execute the DescribeScalingActivities service method on AmazonAutoScaling.

戻り値:

The response from the DescribeScalingActivities service method, as returned by AmazonAutoScaling.

例外:

InvalidNextTokenException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeNotificationConfigurations

public DescribeNotificationConfigurationsResult describeNotificationConfigurations(DescribeNotificationConfigurationsRequest describeNotificationConfigurationsRequest)
                                                                            throws AmazonServiceException,
                                                                                   AmazonClientException

Returns a list of notification actions associated with Auto Scaling groups for specified events.

定義:

describeNotificationConfigurations インタフェース内 AmazonAutoScaling

パラメータ:

describeNotificationConfigurationsRequest - Container for the necessary parameters to execute the DescribeNotificationConfigurations service method on AmazonAutoScaling.

戻り値:

The response from the DescribeNotificationConfigurations service method, as returned by AmazonAutoScaling.

例外:

InvalidNextTokenException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeTerminationPolicyTypes

public DescribeTerminationPolicyTypesResult describeTerminationPolicyTypes(DescribeTerminationPolicyTypesRequest describeTerminationPolicyTypesRequest)
                                                                    throws AmazonServiceException,
                                                                           AmazonClientException

Returns a list of all termination policies supported by Auto Scaling.

定義:

describeTerminationPolicyTypes インタフェース内 AmazonAutoScaling

パラメータ:

describeTerminationPolicyTypesRequest - Container for the necessary parameters to execute the DescribeTerminationPolicyTypes service method on AmazonAutoScaling.

戻り値:

The response from the DescribeTerminationPolicyTypes service method, as returned by AmazonAutoScaling.

例外:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeTags

public DescribeTagsResult describeTags(DescribeTagsRequest describeTagsRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

Lists the Auto Scaling group tags.

You can use filters to limit results when describing tags. For example, you can query for tags of a particular Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results.

You can also specify multiple filters. The result includes information for a particular tag only if it matches all your filters. If there's no match, no special message is returned.

定義:

describeTags インタフェース内 AmazonAutoScaling

パラメータ:

describeTagsRequest - Container for the necessary parameters to execute the DescribeTags service method on AmazonAutoScaling.

戻り値:

The response from the DescribeTags service method, as returned by AmazonAutoScaling.

例外:

InvalidNextTokenException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

executePolicy

public void executePolicy(ExecutePolicyRequest executePolicyRequest)
                   throws AmazonServiceException,
                          AmazonClientException

Runs the policy you create for your Auto Scaling group in PutScalingPolicy.

定義:

executePolicy インタフェース内 AmazonAutoScaling

パラメータ:

executePolicyRequest - Container for the necessary parameters to execute the ExecutePolicy service method on AmazonAutoScaling.

例外:

ScalingActivityInProgressException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

deleteTags

public void deleteTags(DeleteTagsRequest deleteTagsRequest)
                throws AmazonServiceException,
                       AmazonClientException

Removes the specified tags or a set of tags from a set of resources.

定義:

deleteTags インタフェース内 AmazonAutoScaling

パラメータ:

deleteTagsRequest - Container for the necessary parameters to execute the DeleteTags service method on AmazonAutoScaling.

例外:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

putScalingPolicy

public PutScalingPolicyResult putScalingPolicy(PutScalingPolicyRequest putScalingPolicyRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

Creates or updates a policy for an Auto Scaling group. To update an existing policy, use the existing policy name and set the parameter(s) you want to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request.

定義:

putScalingPolicy インタフェース内 AmazonAutoScaling

パラメータ:

putScalingPolicyRequest - Container for the necessary parameters to execute the PutScalingPolicy service method on AmazonAutoScaling.

戻り値:

The response from the PutScalingPolicy service method, as returned by AmazonAutoScaling.

例外:

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

putNotificationConfiguration

public void putNotificationConfiguration(PutNotificationConfigurationRequest putNotificationConfigurationRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to this topic can have messages for events delivered to an endpoint such as a web server or email address.

A new PutNotificationConfiguration overwrites an existing configuration.

定義:

putNotificationConfiguration インタフェース内 AmazonAutoScaling

パラメータ:

putNotificationConfigurationRequest - Container for the necessary parameters to execute the PutNotificationConfiguration service method on AmazonAutoScaling.

例外:

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

deletePolicy

public void deletePolicy(DeletePolicyRequest deletePolicyRequest)
                  throws AmazonServiceException,
                         AmazonClientException

Deletes a policy created by PutScalingPolicy.

定義:

deletePolicy インタフェース内 AmazonAutoScaling

パラメータ:

deletePolicyRequest - Container for the necessary parameters to execute the DeletePolicy service method on AmazonAutoScaling.

例外:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

deleteNotificationConfiguration

public void deleteNotificationConfiguration(DeleteNotificationConfigurationRequest deleteNotificationConfigurationRequest)
                                     throws AmazonServiceException,
                                            AmazonClientException

Deletes notifications created by PutNotificationConfiguration.

定義:

deleteNotificationConfiguration インタフェース内 AmazonAutoScaling

パラメータ:

deleteNotificationConfigurationRequest - Container for the necessary parameters to execute the DeleteNotificationConfiguration service method on AmazonAutoScaling.

例外:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

deleteScheduledAction

public void deleteScheduledAction(DeleteScheduledActionRequest deleteScheduledActionRequest)
                           throws AmazonServiceException,
                                  AmazonClientException

Deletes a scheduled action previously created using the PutScheduledUpdateGroupAction.

定義:

deleteScheduledAction インタフェース内 AmazonAutoScaling

パラメータ:

deleteScheduledActionRequest - Container for the necessary parameters to execute the DeleteScheduledAction service method on AmazonAutoScaling.

例外:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

setInstanceHealth

public void setInstanceHealth(SetInstanceHealthRequest setInstanceHealthRequest)
                       throws AmazonServiceException,
                              AmazonClientException

Sets the health status of an instance.

定義:

setInstanceHealth インタフェース内 AmazonAutoScaling

パラメータ:

setInstanceHealthRequest - Container for the necessary parameters to execute the SetInstanceHealth service method on AmazonAutoScaling.

例外:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeAutoScalingNotificationTypes

public DescribeAutoScalingNotificationTypesResult describeAutoScalingNotificationTypes(DescribeAutoScalingNotificationTypesRequest describeAutoScalingNotificationTypesRequest)
                                                                                throws AmazonServiceException,
                                                                                       AmazonClientException

Returns a list of all notification types that are supported by Auto Scaling.

定義:

describeAutoScalingNotificationTypes インタフェース内 AmazonAutoScaling

パラメータ:

describeAutoScalingNotificationTypesRequest - Container for the necessary parameters to execute the DescribeAutoScalingNotificationTypes service method on AmazonAutoScaling.

戻り値:

The response from the DescribeAutoScalingNotificationTypes service method, as returned by AmazonAutoScaling.

例外:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

createOrUpdateTags

public void createOrUpdateTags(CreateOrUpdateTagsRequest createOrUpdateTagsRequest)
                        throws AmazonServiceException,
                               AmazonClientException

Creates new tags or updates existing tags for an Auto Scaling group.

NOTE: A tag's definition is composed of a resource ID, resource type, key and value, and the propagate flag. Value and the propagate flag are optional parameters. See the Request Parameters for more information.

定義:

createOrUpdateTags インタフェース内 AmazonAutoScaling

パラメータ:

createOrUpdateTagsRequest - Container for the necessary parameters to execute the CreateOrUpdateTags service method on AmazonAutoScaling.

例外:

LimitExceededException

AlreadyExistsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

suspendProcesses

public void suspendProcesses(SuspendProcessesRequest suspendProcessesRequest)
                      throws AmazonServiceException,
                             AmazonClientException

Suspends Auto Scaling processes for an Auto Scaling group. To suspend specific process types, specify them by name with the ScalingProcesses.member.N parameter. To suspend all process types, omit the ScalingProcesses.member.N parameter.

IMPORTANT: Suspending either of the two primary process types, Launch or Terminate, can prevent other process types from functioning properly. For more information about processes and their dependencies, see ProcessType.

To resume processes that have been suspended, use ResumeProcesses.

定義:

suspendProcesses インタフェース内 AmazonAutoScaling

パラメータ:

suspendProcessesRequest - Container for the necessary parameters to execute the SuspendProcesses service method on AmazonAutoScaling.

例外:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeAutoScalingInstances

public DescribeAutoScalingInstancesResult describeAutoScalingInstances(DescribeAutoScalingInstancesRequest describeAutoScalingInstancesRequest)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

Returns a description of each Auto Scaling instance in the InstanceIds list. If a list is not provided, the service returns the full details of all instances up to a maximum of 50. By default, the service returns a list of 20 items.

This action supports pagination by returning a token if there are more pages to retrieve. To get the next page, call this action again with the returned token as the NextToken parameter.

定義:

describeAutoScalingInstances インタフェース内 AmazonAutoScaling

パラメータ:

describeAutoScalingInstancesRequest - Container for the necessary parameters to execute the DescribeAutoScalingInstances service method on AmazonAutoScaling.

戻り値:

The response from the DescribeAutoScalingInstances service method, as returned by AmazonAutoScaling.

例外:

InvalidNextTokenException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

createLaunchConfiguration

public void createLaunchConfiguration(CreateLaunchConfigurationRequest createLaunchConfigurationRequest)
                               throws AmazonServiceException,
                                      AmazonClientException

Creates a new launch configuration. The launch configuration name must be unique within the scope of the client's AWS account. The maximum limit of launch configurations, which by default is 100, must not yet have been met; otherwise, the call will fail. When created, the new launch configuration is available for immediate use.

You can create a launch configuration with Amazon EC2 security groups or with Amazon VPC security groups. However, you can't use Amazon EC2 security groups together with Amazon VPC security groups, or vice versa.

NOTE: At this time, Auto Scaling launch configurations don't support compressed (e.g. zipped) user data files.

定義:

createLaunchConfiguration インタフェース内 AmazonAutoScaling

パラメータ:

createLaunchConfigurationRequest - Container for the necessary parameters to execute the CreateLaunchConfiguration service method on AmazonAutoScaling.

例外:

LimitExceededException

AlreadyExistsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

deleteAutoScalingGroup

public void deleteAutoScalingGroup(DeleteAutoScalingGroupRequest deleteAutoScalingGroupRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Deletes the specified Auto Scaling group if the group has no instances and no scaling activities in progress.

NOTE: To remove all instances before calling DeleteAutoScalingGroup, you can call UpdateAutoScalingGroup to set the minimum and maximum size of the AutoScalingGroup to zero.

定義:

deleteAutoScalingGroup インタフェース内 AmazonAutoScaling

パラメータ:

deleteAutoScalingGroupRequest - Container for the necessary parameters to execute the DeleteAutoScalingGroup service method on AmazonAutoScaling.

例外:

ResourceInUseException

ScalingActivityInProgressException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

disableMetricsCollection

public void disableMetricsCollection(DisableMetricsCollectionRequest disableMetricsCollectionRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

Disables monitoring of group metrics for the Auto Scaling group specified in AutoScalingGroupName . You can specify the list of affected metrics with the Metrics parameter.

定義:

disableMetricsCollection インタフェース内 AmazonAutoScaling

パラメータ:

disableMetricsCollectionRequest - Container for the necessary parameters to execute the DisableMetricsCollection service method on AmazonAutoScaling.

例外:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

updateAutoScalingGroup

public void updateAutoScalingGroup(UpdateAutoScalingGroupRequest updateAutoScalingGroupRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Updates the configuration for the specified AutoScalingGroup.

NOTE: To update an Auto Scaling group with a launch configuration that has the InstanceMonitoring flag set to False, you must first ensure that collection of group metrics is disabled. Otherwise, calls to UpdateAutoScalingGroup will fail. If you have previously enabled group metrics collection, you can disable collection of all group metrics by calling DisableMetricsCollection.

The new settings are registered upon the completion of this call. Any launch configuration settings take effect on any triggers after this call returns. Triggers that are currently in progress aren't affected.

NOTE: If a new value is specified for MinSize without specifying the value for DesiredCapacity, and if the new MinSize is larger than the current size of the Auto Scaling Group, there will be an implicit call to SetDesiredCapacity to set the group to the new MinSize. If a new value is specified for MaxSize without specifying the value for DesiredCapacity, and the new MaxSize is smaller than the current size of the Auto Scaling Group, there will be an implicit call to SetDesiredCapacity to set the group to the new MaxSize. All other optional parameters are left unchanged if not passed in the request.

定義:

updateAutoScalingGroup インタフェース内 AmazonAutoScaling

パラメータ:

updateAutoScalingGroupRequest - Container for the necessary parameters to execute the UpdateAutoScalingGroup service method on AmazonAutoScaling.

例外:

ScalingActivityInProgressException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeLaunchConfigurations

public DescribeLaunchConfigurationsResult describeLaunchConfigurations(DescribeLaunchConfigurationsRequest describeLaunchConfigurationsRequest)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

Returns a full description of the launch configurations, or the specified launch configurations, if they exist.

If no name is specified, then the full details of all launch configurations are returned.

定義:

describeLaunchConfigurations インタフェース内 AmazonAutoScaling

パラメータ:

describeLaunchConfigurationsRequest - Container for the necessary parameters to execute the DescribeLaunchConfigurations service method on AmazonAutoScaling.

戻り値:

The response from the DescribeLaunchConfigurations service method, as returned by AmazonAutoScaling.

例外:

InvalidNextTokenException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeAdjustmentTypes

public DescribeAdjustmentTypesResult describeAdjustmentTypes(DescribeAdjustmentTypesRequest describeAdjustmentTypesRequest)
                                                      throws AmazonServiceException,
                                                             AmazonClientException

Returns policy adjustment types for use in the PutScalingPolicy action.

定義:

describeAdjustmentTypes インタフェース内 AmazonAutoScaling

パラメータ:

describeAdjustmentTypesRequest - Container for the necessary parameters to execute the DescribeAdjustmentTypes service method on AmazonAutoScaling.

戻り値:

The response from the DescribeAdjustmentTypes service method, as returned by AmazonAutoScaling.

例外:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeScheduledActions

public DescribeScheduledActionsResult describeScheduledActions(DescribeScheduledActionsRequest describeScheduledActionsRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException

Lists all the actions scheduled for your Auto Scaling group that haven't been executed. To see a list of actions already executed, see the activity record returned in DescribeScalingActivities.

定義:

describeScheduledActions インタフェース内 AmazonAutoScaling

パラメータ:

describeScheduledActionsRequest - Container for the necessary parameters to execute the DescribeScheduledActions service method on AmazonAutoScaling.

戻り値:

The response from the DescribeScheduledActions service method, as returned by AmazonAutoScaling.

例外:

InvalidNextTokenException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

putScheduledUpdateGroupAction

public void putScheduledUpdateGroupAction(PutScheduledUpdateGroupActionRequest putScheduledUpdateGroupActionRequest)
                                   throws AmazonServiceException,
                                          AmazonClientException

Creates a scheduled scaling action for an Auto Scaling group. If you leave a parameter unspecified, the corresponding value remains unchanged in the affected Auto Scaling group.

定義:

putScheduledUpdateGroupAction インタフェース内 AmazonAutoScaling

パラメータ:

putScheduledUpdateGroupActionRequest - Container for the necessary parameters to execute the PutScheduledUpdateGroupAction service method on AmazonAutoScaling.

例外:

LimitExceededException

AlreadyExistsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeMetricCollectionTypes

public DescribeMetricCollectionTypesResult describeMetricCollectionTypes(DescribeMetricCollectionTypesRequest describeMetricCollectionTypesRequest)
                                                                  throws AmazonServiceException,
                                                                         AmazonClientException

Returns a list of metrics and a corresponding list of granularities for each metric.

定義:

describeMetricCollectionTypes インタフェース内 AmazonAutoScaling

パラメータ:

describeMetricCollectionTypesRequest - Container for the necessary parameters to execute the DescribeMetricCollectionTypes service method on AmazonAutoScaling.

戻り値:

The response from the DescribeMetricCollectionTypes service method, as returned by AmazonAutoScaling.

例外:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

setDesiredCapacity

public void setDesiredCapacity(SetDesiredCapacityRequest setDesiredCapacityRequest)
                        throws AmazonServiceException,
                               AmazonClientException

Adjusts the desired size of the AutoScalingGroup by initiating scaling activities. When reducing the size of the group, it is not possible to define which Amazon EC2 instances will be terminated. This applies to any Auto Scaling decisions that might result in terminating instances.

There are two common use cases for SetDesiredCapacity : one for users of the Auto Scaling triggering system, and another for developers who write their own triggering systems. Both use cases relate to the concept of cooldown.

In the first case, if you use the Auto Scaling triggering system, SetDesiredCapacity changes the size of your Auto Scaling group without regard to the cooldown period. This could be useful, for example, if Auto Scaling did something unexpected for some reason. If your cooldown period is 10 minutes, Auto Scaling would normally reject requests to change the size of the group for that entire 10-minute period. The SetDesiredCapacity command allows you to circumvent this restriction and change the size of the group before the end of the cooldown period.

In the second case, if you write your own triggering system, you can use SetDesiredCapacity to control the size of your Auto Scaling group. If you want the same cooldown functionality that Auto Scaling offers, you can configure SetDesiredCapacity to honor cooldown by setting the HonorCooldown parameter to true .

定義:

setDesiredCapacity インタフェース内 AmazonAutoScaling

パラメータ:

setDesiredCapacityRequest - Container for the necessary parameters to execute the SetDesiredCapacity service method on AmazonAutoScaling.

例外:

ScalingActivityInProgressException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

terminateInstanceInAutoScalingGroup

public TerminateInstanceInAutoScalingGroupResult terminateInstanceInAutoScalingGroup(TerminateInstanceInAutoScalingGroupRequest terminateInstanceInAutoScalingGroupRequest)
                                                                              throws AmazonServiceException,
                                                                                     AmazonClientException

Terminates the specified instance. Optionally, the desired group size can be adjusted.

NOTE: This call simply registers a termination request. The termination of the instance cannot happen immediately.

定義:

terminateInstanceInAutoScalingGroup インタフェース内 AmazonAutoScaling

パラメータ:

terminateInstanceInAutoScalingGroupRequest - Container for the necessary parameters to execute the TerminateInstanceInAutoScalingGroup service method on AmazonAutoScaling.

戻り値:

The response from the TerminateInstanceInAutoScalingGroup service method, as returned by AmazonAutoScaling.

例外:

ScalingActivityInProgressException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeAutoScalingGroups

public DescribeAutoScalingGroupsResult describeAutoScalingGroups()
                                                          throws AmazonServiceException,
                                                                 AmazonClientException

Returns a full description of each Auto Scaling group in the given list. This includes all Amazon EC2 instances that are members of the group. If a list of names is not provided, the service returns the full details of all Auto Scaling groups.

This action supports pagination by returning a token if there are more pages to retrieve. To get the next page, call this action again with the returned token as the NextToken parameter.

定義:

describeAutoScalingGroups インタフェース内 AmazonAutoScaling

戻り値:

The response from the DescribeAutoScalingGroups service method, as returned by AmazonAutoScaling.

例外:

InvalidNextTokenException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describePolicies

public DescribePoliciesResult describePolicies()
                                        throws AmazonServiceException,
                                               AmazonClientException

Returns descriptions of what each policy does. This action supports pagination. If the response includes a token, there are more records available. To get the additional records, repeat the request with the response token as the NextToken parameter.

定義:

describePolicies インタフェース内 AmazonAutoScaling

戻り値:

The response from the DescribePolicies service method, as returned by AmazonAutoScaling.

例外:

InvalidNextTokenException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeScalingProcessTypes

public DescribeScalingProcessTypesResult describeScalingProcessTypes()
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

Returns scaling process types for use in the ResumeProcesses and SuspendProcesses actions.

定義:

describeScalingProcessTypes インタフェース内 AmazonAutoScaling

戻り値:

The response from the DescribeScalingProcessTypes service method, as returned by AmazonAutoScaling.

例外:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeScalingActivities

public DescribeScalingActivitiesResult describeScalingActivities()
                                                          throws AmazonServiceException,
                                                                 AmazonClientException

Returns the scaling activities for the specified Auto Scaling group.

If the specified ActivityIds list is empty, all the activities from the past six weeks are returned. Activities are sorted by completion time. Activities still in progress appear first on the list.

This action supports pagination. If the response includes a token, there are more records available. To get the additional records, repeat the request with the response token as the NextToken parameter.

定義:

describeScalingActivities インタフェース内 AmazonAutoScaling

戻り値:

The response from the DescribeScalingActivities service method, as returned by AmazonAutoScaling.

例外:

InvalidNextTokenException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeNotificationConfigurations

public DescribeNotificationConfigurationsResult describeNotificationConfigurations()
                                                                            throws AmazonServiceException,
                                                                                   AmazonClientException

Returns a list of notification actions associated with Auto Scaling groups for specified events.

定義:

describeNotificationConfigurations インタフェース内 AmazonAutoScaling

戻り値:

The response from the DescribeNotificationConfigurations service method, as returned by AmazonAutoScaling.

例外:

InvalidNextTokenException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeTerminationPolicyTypes

public DescribeTerminationPolicyTypesResult describeTerminationPolicyTypes()
                                                                    throws AmazonServiceException,
                                                                           AmazonClientException

Returns a list of all termination policies supported by Auto Scaling.

定義:

describeTerminationPolicyTypes インタフェース内 AmazonAutoScaling

戻り値:

The response from the DescribeTerminationPolicyTypes service method, as returned by AmazonAutoScaling.

例外:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeTags

public DescribeTagsResult describeTags()
                                throws AmazonServiceException,
                                       AmazonClientException

Lists the Auto Scaling group tags.

You can use filters to limit results when describing tags. For example, you can query for tags of a particular Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results.

You can also specify multiple filters. The result includes information for a particular tag only if it matches all your filters. If there's no match, no special message is returned.

定義:

describeTags インタフェース内 AmazonAutoScaling

戻り値:

The response from the DescribeTags service method, as returned by AmazonAutoScaling.

例外:

InvalidNextTokenException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeAutoScalingNotificationTypes

public DescribeAutoScalingNotificationTypesResult describeAutoScalingNotificationTypes()
                                                                                throws AmazonServiceException,
                                                                                       AmazonClientException

Returns a list of all notification types that are supported by Auto Scaling.

定義:

describeAutoScalingNotificationTypes インタフェース内 AmazonAutoScaling

戻り値:

The response from the DescribeAutoScalingNotificationTypes service method, as returned by AmazonAutoScaling.

例外:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeAutoScalingInstances

public DescribeAutoScalingInstancesResult describeAutoScalingInstances()
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

Returns a description of each Auto Scaling instance in the InstanceIds list. If a list is not provided, the service returns the full details of all instances up to a maximum of 50. By default, the service returns a list of 20 items.

This action supports pagination by returning a token if there are more pages to retrieve. To get the next page, call this action again with the returned token as the NextToken parameter.

定義:

describeAutoScalingInstances インタフェース内 AmazonAutoScaling

戻り値:

The response from the DescribeAutoScalingInstances service method, as returned by AmazonAutoScaling.

例外:

InvalidNextTokenException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeLaunchConfigurations

public DescribeLaunchConfigurationsResult describeLaunchConfigurations()
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

Returns a full description of the launch configurations, or the specified launch configurations, if they exist.

If no name is specified, then the full details of all launch configurations are returned.

定義:

describeLaunchConfigurations インタフェース内 AmazonAutoScaling

戻り値:

The response from the DescribeLaunchConfigurations service method, as returned by AmazonAutoScaling.

例外:

InvalidNextTokenException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeAdjustmentTypes

public DescribeAdjustmentTypesResult describeAdjustmentTypes()
                                                      throws AmazonServiceException,
                                                             AmazonClientException

Returns policy adjustment types for use in the PutScalingPolicy action.

定義:

describeAdjustmentTypes インタフェース内 AmazonAutoScaling

戻り値:

The response from the DescribeAdjustmentTypes service method, as returned by AmazonAutoScaling.

例外:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeScheduledActions

public DescribeScheduledActionsResult describeScheduledActions()
                                                        throws AmazonServiceException,
                                                               AmazonClientException

Lists all the actions scheduled for your Auto Scaling group that haven't been executed. To see a list of actions already executed, see the activity record returned in DescribeScalingActivities.

定義:

describeScheduledActions インタフェース内 AmazonAutoScaling

戻り値:

The response from the DescribeScheduledActions service method, as returned by AmazonAutoScaling.

例外:

InvalidNextTokenException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeMetricCollectionTypes

public DescribeMetricCollectionTypesResult describeMetricCollectionTypes()
                                                                  throws AmazonServiceException,
                                                                         AmazonClientException

Returns a list of metrics and a corresponding list of granularities for each metric.

定義:

describeMetricCollectionTypes インタフェース内 AmazonAutoScaling

戻り値:

The response from the DescribeMetricCollectionTypes service method, as returned by AmazonAutoScaling.

例外:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

setEndpoint

public void setEndpoint(java.lang.String endpoint,
               java.lang.String serviceName,
               java.lang.String regionId)
                 throws java.lang.IllegalArgumentException

Overrides the default endpoint for this client ("https://autoscaling.amazonaws.com") and explicitly provides an AWS region ID and AWS service name to use when the client calculates a signature for requests. In almost all cases, this region ID and service name are automatically determined from the endpoint, and callers should use the simpler one-argument form of setEndpoint instead of this method.

This method is not threadsafe. Endpoints should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit.

Callers can pass in just the endpoint (ex: "autoscaling.amazonaws.com") or a full URL, including the protocol (ex: "https://autoscaling.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

パラメータ:

endpoint - The endpoint (ex: "autoscaling.amazonaws.com") or a full URL, including the protocol (ex: "https://autoscaling.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

serviceName - The name of the AWS service to use when signing requests.

regionId - The ID of the region in which this service resides.

例外:

java.lang.IllegalArgumentException - If any problems are detected with the specified endpoint.

getServiceAbbreviation

protected java.lang.String getServiceAbbreviation()

クラスからコピーされた説明: AmazonWebServiceClient

リージョンによるサービスエンドポイントを特定するために、このサービスに対する 略称を返します

オーバーライド:

getServiceAbbreviation クラス内 AmazonWebServiceClient

関連項目:

ServiceAbbreviations

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

定義:

getCachedResponseMetadata インタフェース内 AmazonAutoScaling

パラメータ:

request - The originally executed request

戻り値:

The response metadata for the specified request, or null if none is available.