public class AmazonCloudWatchClient extends AmazonWebServiceClient implements AmazonCloudWatch
Amazon CloudWatch
This is the Amazon CloudWatch API Reference . This guide provides detailed information about Amazon CloudWatch actions, data types, parameters, and errors. For detailed information about Amazon CloudWatch features and their associated API calls, go to the Amazon CloudWatch Developer Guide .
Amazon CloudWatch is a web service that enables you to publish, monitor, and manage various metrics, as well as configure alarm actions based on data from metrics. For more information about this product go to http://aws.amazon.com/cloudwatch .
Use the following links to get started using the Amazon CloudWatch API Reference :
| 修飾子とタイプ | フィールドと説明 |
|---|---|
protected java.util.List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,org.w3c.dom.Node>> |
exceptionUnmarshallers
List of exception unmarshallers for all AmazonCloudWatch exceptions.
|
client, clientConfiguration, endpoint, requestHandlers, timeOffset, version| コンストラクタと説明 |
|---|
AmazonCloudWatchClient()
Constructs a new client to invoke service methods on
AmazonCloudWatch.
|
AmazonCloudWatchClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on
AmazonCloudWatch using the specified AWS account credentials.
|
AmazonCloudWatchClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonCloudWatch using the specified AWS account credentials
and client configuration options.
|
AmazonCloudWatchClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on
AmazonCloudWatch using the specified AWS account credentials provider.
|
AmazonCloudWatchClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonCloudWatch using the specified AWS account credentials
provider and client configuration options.
|
AmazonCloudWatchClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonCloudWatch.
|
| 修飾子とタイプ | メソッドと説明 |
|---|---|
void |
deleteAlarms(DeleteAlarmsRequest deleteAlarmsRequest)
Deletes all specified alarms.
|
DescribeAlarmHistoryResult |
describeAlarmHistory()
Retrieves history for the specified alarm.
|
DescribeAlarmHistoryResult |
describeAlarmHistory(DescribeAlarmHistoryRequest describeAlarmHistoryRequest)
Retrieves history for the specified alarm.
|
DescribeAlarmsResult |
describeAlarms()
Retrieves alarms with the specified names.
|
DescribeAlarmsResult |
describeAlarms(DescribeAlarmsRequest describeAlarmsRequest)
Retrieves alarms with the specified names.
|
DescribeAlarmsForMetricResult |
describeAlarmsForMetric(DescribeAlarmsForMetricRequest describeAlarmsForMetricRequest)
Retrieves all alarms for a single metric.
|
void |
disableAlarmActions(DisableAlarmActionsRequest disableAlarmActionsRequest)
Disables actions for the specified alarms.
|
void |
enableAlarmActions(EnableAlarmActionsRequest enableAlarmActionsRequest)
Enables actions for the specified alarms.
|
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.
|
GetMetricStatisticsResult |
getMetricStatistics(GetMetricStatisticsRequest getMetricStatisticsRequest)
Gets statistics for the specified metric.
|
protected java.lang.String |
getServiceAbbreviation()
リージョンによるサービスエンドポイントを特定するために、このサービスに対する
略称を返します
|
ListMetricsResult |
listMetrics()
Returns a list of valid metrics stored for the AWS account owner.
|
ListMetricsResult |
listMetrics(ListMetricsRequest listMetricsRequest)
Returns a list of valid metrics stored for the AWS account owner.
|
void |
putMetricAlarm(PutMetricAlarmRequest putMetricAlarmRequest)
Creates or updates an alarm and associates it with the specified
Amazon CloudWatch metric.
|
void |
putMetricData(PutMetricDataRequest putMetricDataRequest)
Publishes metric data points to Amazon CloudWatch.
|
void |
setAlarmState(SetAlarmStateRequest setAlarmStateRequest)
Temporarily sets the state of an alarm.
|
void |
setEndpoint(java.lang.String endpoint,
java.lang.String serviceName,
java.lang.String regionId)
Overrides the default endpoint for this client ("https://monitoring.amazonaws.com") and explicitly provides
an AWS region ID and AWS service name to use when the client calculates a signature
for requests.
|
addRequestHandler, convertToHttpRequest, createExecutionContext, getTimeOffset, getVersion, removeRequestHandler, setConfiguration, setEndpoint, setRegion, setTimeOffset, setVersion, shutdown, withTimeOffsetclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion, shutdownprotected final java.util.List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,org.w3c.dom.Node>> exceptionUnmarshallers
public AmazonCloudWatchClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderpublic AmazonCloudWatchClient(ClientConfiguration clientConfiguration)
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 AmazonCloudWatch
(ex: proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderpublic AmazonCloudWatchClient(AWSCredentials awsCredentials)
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.public AmazonCloudWatchClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
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 AmazonCloudWatch
(ex: proxy settings, retry counts, etc.).public AmazonCloudWatchClient(AWSCredentialsProvider awsCredentialsProvider)
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.public AmazonCloudWatchClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
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 AmazonCloudWatch
(ex: proxy settings, retry counts, etc.).public void putMetricAlarm(PutMetricAlarmRequest putMetricAlarmRequest) throws AmazonServiceException, AmazonClientException
Creates or updates an alarm and associates it with the specified Amazon CloudWatch metric. Optionally, this operation can associate one or more Amazon Simple Notification Service resources with the alarm.
When this operation creates an alarm, the alarm state is immediately
set to INSUFFICIENT_DATA . The alarm is evaluated and
its StateValue is set appropriately. Any actions
associated with the StateValue is then executed.
NOTE: When updating an existing alarm, its StateValue is left unchanged.
putMetricAlarm インタフェース内 AmazonCloudWatchputMetricAlarmRequest - Container for the necessary parameters to
execute the PutMetricAlarm service method on AmazonCloudWatch.LimitExceededExceptionAmazonClientException - 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 AmazonCloudWatch indicating
either a problem with the data in the request, or a server side issue.public void putMetricData(PutMetricDataRequest putMetricDataRequest) throws AmazonServiceException, AmazonClientException
Publishes metric data points to Amazon CloudWatch. Amazon Cloudwatch associates the data points with the specified metric. If the specified metric does not exist, Amazon CloudWatch creates the metric.
NOTE: If you create a metric with the PutMetricData action, allow up to fifteen minutes for the metric to appear in calls to the ListMetrics action.
The size of a PutMetricData request is limited to 8 KB for HTTP GET requests and 40 KB for HTTP POST requests.
IMPORTANT: Although the Value parameter accepts numbers of type Double, Amazon CloudWatch truncates values with very large exponents. Values with base-10 exponents greater than 126 (1 x 10^126) are truncated. Likewise, values with base-10 exponents less than -130 (1 x 10^-130) are also truncated.
putMetricData インタフェース内 AmazonCloudWatchputMetricDataRequest - Container for the necessary parameters to
execute the PutMetricData service method on AmazonCloudWatch.InvalidParameterValueExceptionInternalServiceExceptionInvalidParameterCombinationExceptionMissingRequiredParameterExceptionAmazonClientException - 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 AmazonCloudWatch indicating
either a problem with the data in the request, or a server side issue.public ListMetricsResult listMetrics(ListMetricsRequest listMetricsRequest) throws AmazonServiceException, AmazonClientException
Returns a list of valid metrics stored for the AWS account owner.
Returned metrics can be used with GetMetricStatistics to
obtain statistical data for a given metric.
NOTE: Up to 500 results are returned for any one call. To retrieve further results, use returned NextToken values with subsequent ListMetrics operations.
NOTE: If you create a metric with the PutMetricData action, allow up to fifteen minutes for the metric to appear in calls to the ListMetrics action.
listMetrics インタフェース内 AmazonCloudWatchlistMetricsRequest - Container for the necessary parameters to
execute the ListMetrics service method on AmazonCloudWatch.InternalServiceExceptionInvalidParameterValueExceptionAmazonClientException - 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 AmazonCloudWatch indicating
either a problem with the data in the request, or a server side issue.public GetMetricStatisticsResult getMetricStatistics(GetMetricStatisticsRequest getMetricStatisticsRequest) throws AmazonServiceException, AmazonClientException
Gets statistics for the specified metric.
NOTE: The maximum number of data points returned from a single GetMetricStatistics request is 1,440. If a request is made that generates more than 1,440 data points, Amazon CloudWatch returns an error. In such a case, alter the request by narrowing the specified time range or increasing the specified period. Alternatively, make multiple requests across adjacent time ranges.
Amazon CloudWatch aggregates data points based on the length of the
period that you specify. For example, if you request
statistics with a one-minute granularity, Amazon CloudWatch aggregates
data points with time stamps that fall within the same one-minute
period. In such a case, the data points queried can greatly outnumber
the data points returned.
NOTE: The maximum number of data points that can be queried is 50,850; whereas the maximum number of data points returned is 1,440.
The following examples show various statistics allowed by the data
point query maximum of 50,850 when you call
GetMetricStatistics on Amazon EC2 instances with detailed
(one-minute) monitoring enabled:
getMetricStatistics インタフェース内 AmazonCloudWatchgetMetricStatisticsRequest - Container for the necessary
parameters to execute the GetMetricStatistics service method on
AmazonCloudWatch.InvalidParameterValueExceptionInternalServiceExceptionInvalidParameterCombinationExceptionMissingRequiredParameterExceptionAmazonClientException - 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 AmazonCloudWatch indicating
either a problem with the data in the request, or a server side issue.public void disableAlarmActions(DisableAlarmActionsRequest disableAlarmActionsRequest) throws AmazonServiceException, AmazonClientException
Disables actions for the specified alarms. When an alarm's actions are disabled the alarm's state may change, but none of the alarm's actions will execute.
disableAlarmActions インタフェース内 AmazonCloudWatchdisableAlarmActionsRequest - Container for the necessary
parameters to execute the DisableAlarmActions service method on
AmazonCloudWatch.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 AmazonCloudWatch indicating
either a problem with the data in the request, or a server side issue.public DescribeAlarmsResult describeAlarms(DescribeAlarmsRequest describeAlarmsRequest) throws AmazonServiceException, AmazonClientException
Retrieves alarms with the specified names. If no name is specified, all alarms for the user are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action.
describeAlarms インタフェース内 AmazonCloudWatchdescribeAlarmsRequest - Container for the necessary parameters to
execute the DescribeAlarms service method on AmazonCloudWatch.InvalidNextTokenExceptionAmazonClientException - 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 AmazonCloudWatch indicating
either a problem with the data in the request, or a server side issue.public DescribeAlarmsForMetricResult describeAlarmsForMetric(DescribeAlarmsForMetricRequest describeAlarmsForMetricRequest) throws AmazonServiceException, AmazonClientException
Retrieves all alarms for a single metric. Specify a statistic, period, or unit to filter the set of alarms further.
describeAlarmsForMetric インタフェース内 AmazonCloudWatchdescribeAlarmsForMetricRequest - Container for the necessary
parameters to execute the DescribeAlarmsForMetric service method on
AmazonCloudWatch.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 AmazonCloudWatch indicating
either a problem with the data in the request, or a server side issue.public DescribeAlarmHistoryResult describeAlarmHistory(DescribeAlarmHistoryRequest describeAlarmHistoryRequest) throws AmazonServiceException, AmazonClientException
Retrieves history for the specified alarm. Filter alarms by date range or item type. If an alarm name is not specified, Amazon CloudWatch returns histories for all of the owner's alarms.
NOTE: Amazon CloudWatch retains the history of an alarm for two weeks, whether or not you delete the alarm.
describeAlarmHistory インタフェース内 AmazonCloudWatchdescribeAlarmHistoryRequest - Container for the necessary
parameters to execute the DescribeAlarmHistory service method on
AmazonCloudWatch.InvalidNextTokenExceptionAmazonClientException - 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 AmazonCloudWatch indicating
either a problem with the data in the request, or a server side issue.public void enableAlarmActions(EnableAlarmActionsRequest enableAlarmActionsRequest) throws AmazonServiceException, AmazonClientException
Enables actions for the specified alarms.
enableAlarmActions インタフェース内 AmazonCloudWatchenableAlarmActionsRequest - Container for the necessary
parameters to execute the EnableAlarmActions service method on
AmazonCloudWatch.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 AmazonCloudWatch indicating
either a problem with the data in the request, or a server side issue.public void deleteAlarms(DeleteAlarmsRequest deleteAlarmsRequest) throws AmazonServiceException, AmazonClientException
Deletes all specified alarms. In the event of an error, no alarms are deleted.
deleteAlarms インタフェース内 AmazonCloudWatchdeleteAlarmsRequest - Container for the necessary parameters to
execute the DeleteAlarms service method on AmazonCloudWatch.ResourceNotFoundExceptionAmazonClientException - 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 AmazonCloudWatch indicating
either a problem with the data in the request, or a server side issue.public void setAlarmState(SetAlarmStateRequest setAlarmStateRequest) throws AmazonServiceException, AmazonClientException
Temporarily sets the state of an alarm. When the updated
StateValue differs from the previous value, the action
configured for the appropriate state is invoked. This is not a
permanent change. The next periodic alarm check (in about a minute)
will set the alarm to its actual state.
setAlarmState インタフェース内 AmazonCloudWatchsetAlarmStateRequest - Container for the necessary parameters to
execute the SetAlarmState service method on AmazonCloudWatch.ResourceNotFoundExceptionInvalidFormatExceptionAmazonClientException - 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 AmazonCloudWatch indicating
either a problem with the data in the request, or a server side issue.public ListMetricsResult listMetrics() throws AmazonServiceException, AmazonClientException
Returns a list of valid metrics stored for the AWS account owner.
Returned metrics can be used with GetMetricStatistics to
obtain statistical data for a given metric.
NOTE: Up to 500 results are returned for any one call. To retrieve further results, use returned NextToken values with subsequent ListMetrics operations.
NOTE: If you create a metric with the PutMetricData action, allow up to fifteen minutes for the metric to appear in calls to the ListMetrics action.
listMetrics インタフェース内 AmazonCloudWatchInternalServiceExceptionInvalidParameterValueExceptionAmazonClientException - 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 AmazonCloudWatch indicating
either a problem with the data in the request, or a server side issue.public DescribeAlarmsResult describeAlarms() throws AmazonServiceException, AmazonClientException
Retrieves alarms with the specified names. If no name is specified, all alarms for the user are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action.
describeAlarms インタフェース内 AmazonCloudWatchInvalidNextTokenExceptionAmazonClientException - 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 AmazonCloudWatch indicating
either a problem with the data in the request, or a server side issue.public DescribeAlarmHistoryResult describeAlarmHistory() throws AmazonServiceException, AmazonClientException
Retrieves history for the specified alarm. Filter alarms by date range or item type. If an alarm name is not specified, Amazon CloudWatch returns histories for all of the owner's alarms.
NOTE: Amazon CloudWatch retains the history of an alarm for two weeks, whether or not you delete the alarm.
describeAlarmHistory インタフェース内 AmazonCloudWatchInvalidNextTokenExceptionAmazonClientException - 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 AmazonCloudWatch indicating
either a problem with the data in the request, or a server side issue.public void setEndpoint(java.lang.String endpoint,
java.lang.String serviceName,
java.lang.String regionId)
throws java.lang.IllegalArgumentException
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: "monitoring.amazonaws.com") or a full
URL, including the protocol (ex: "https://monitoring.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: "monitoring.amazonaws.com") or a full URL,
including the protocol (ex: "https://monitoring.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.protected java.lang.String getServiceAbbreviation()
AmazonWebServiceClientgetServiceAbbreviation クラス内 AmazonWebServiceClientServiceAbbreviationspublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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 インタフェース内 AmazonCloudWatchrequest - The originally executed request