@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSLogs extends Object implements AWSLogs
AWSLogs
. Convenient method forms pass through to the corresponding overload that
takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
AssociateKmsKeyResult |
associateKmsKey(AssociateKmsKeyRequest request)
Associates the specified AWS Key Management Service (AWS KMS) customer master key (CMK) with the specified log
group.
|
CancelExportTaskResult |
cancelExportTask(CancelExportTaskRequest request)
Cancels the specified export task.
|
CreateExportTaskResult |
createExportTask(CreateExportTaskRequest request)
Creates an export task, which allows you to efficiently export data from a log group to an Amazon S3 bucket.
|
CreateLogGroupResult |
createLogGroup(CreateLogGroupRequest request)
Creates a log group with the specified name.
|
CreateLogStreamResult |
createLogStream(CreateLogStreamRequest request)
Creates a log stream for the specified log group.
|
DeleteDestinationResult |
deleteDestination(DeleteDestinationRequest request)
Deletes the specified destination, and eventually disables all the subscription filters that publish to it.
|
DeleteLogGroupResult |
deleteLogGroup(DeleteLogGroupRequest request)
Deletes the specified log group and permanently deletes all the archived log events associated with the log
group.
|
DeleteLogStreamResult |
deleteLogStream(DeleteLogStreamRequest request)
Deletes the specified log stream and permanently deletes all the archived log events associated with the log
stream.
|
DeleteMetricFilterResult |
deleteMetricFilter(DeleteMetricFilterRequest request)
Deletes the specified metric filter.
|
DeleteResourcePolicyResult |
deleteResourcePolicy(DeleteResourcePolicyRequest request)
Deletes a resource policy from this account.
|
DeleteRetentionPolicyResult |
deleteRetentionPolicy(DeleteRetentionPolicyRequest request)
Deletes the specified retention policy.
|
DeleteSubscriptionFilterResult |
deleteSubscriptionFilter(DeleteSubscriptionFilterRequest request)
Deletes the specified subscription filter.
|
DescribeDestinationsResult |
describeDestinations()
Simplified method form for invoking the DescribeDestinations operation.
|
DescribeDestinationsResult |
describeDestinations(DescribeDestinationsRequest request)
Lists all your destinations.
|
DescribeExportTasksResult |
describeExportTasks(DescribeExportTasksRequest request)
Lists the specified export tasks.
|
DescribeLogGroupsResult |
describeLogGroups()
Simplified method form for invoking the DescribeLogGroups operation.
|
DescribeLogGroupsResult |
describeLogGroups(DescribeLogGroupsRequest request)
Lists the specified log groups.
|
DescribeLogStreamsResult |
describeLogStreams(DescribeLogStreamsRequest request)
Lists the log streams for the specified log group.
|
DescribeMetricFiltersResult |
describeMetricFilters(DescribeMetricFiltersRequest request)
Lists the specified metric filters.
|
DescribeResourcePoliciesResult |
describeResourcePolicies(DescribeResourcePoliciesRequest request)
Lists the resource policies in this account.
|
DescribeSubscriptionFiltersResult |
describeSubscriptionFilters(DescribeSubscriptionFiltersRequest request)
Lists the subscription filters for the specified log group.
|
DisassociateKmsKeyResult |
disassociateKmsKey(DisassociateKmsKeyRequest request)
Disassociates the associated AWS Key Management Service (AWS KMS) customer master key (CMK) from the specified
log group.
|
FilterLogEventsResult |
filterLogEvents(FilterLogEventsRequest request)
Lists log events from the specified log group.
|
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.
|
GetLogEventsResult |
getLogEvents(GetLogEventsRequest request)
Lists log events from the specified log stream.
|
ListTagsLogGroupResult |
listTagsLogGroup(ListTagsLogGroupRequest request)
Lists the tags for the specified log group.
|
PutDestinationResult |
putDestination(PutDestinationRequest request)
Creates or updates a destination.
|
PutDestinationPolicyResult |
putDestinationPolicy(PutDestinationPolicyRequest request)
Creates or updates an access policy associated with an existing destination.
|
PutLogEventsResult |
putLogEvents(PutLogEventsRequest request)
Uploads a batch of log events to the specified log stream.
|
PutMetricFilterResult |
putMetricFilter(PutMetricFilterRequest request)
Creates or updates a metric filter and associates it with the specified log group.
|
PutResourcePolicyResult |
putResourcePolicy(PutResourcePolicyRequest request)
Creates or updates a resource policy allowing other AWS services to put log events to this account, such as
Amazon Route 53.
|
PutRetentionPolicyResult |
putRetentionPolicy(PutRetentionPolicyRequest request)
Sets the retention of the specified log group.
|
PutSubscriptionFilterResult |
putSubscriptionFilter(PutSubscriptionFilterRequest request)
Creates or updates a subscription filter and associates it with the specified log group.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("https://logs.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
AWSLogs.setEndpoint(String) , sets the regional endpoint for this client's service
calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagLogGroupResult |
tagLogGroup(TagLogGroupRequest request)
Adds or updates the specified tags for the specified log group.
|
TestMetricFilterResult |
testMetricFilter(TestMetricFilterRequest request)
Tests the filter pattern of a metric filter against a sample of log event messages.
|
UntagLogGroupResult |
untagLogGroup(UntagLogGroupRequest request)
Removes the specified tags from the specified log group.
|
public void setEndpoint(String endpoint)
AWSLogs
Callers can pass in just the endpoint (ex: "logs.us-east-1.amazonaws.com") or a full URL, including the protocol
(ex: "https://logs.us-east-1.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
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint
in interface AWSLogs
endpoint
- The endpoint (ex: "logs.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"https://logs.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate
with.public void setRegion(Region region)
AWSLogs
AWSLogs.setEndpoint(String)
, sets the regional endpoint for this client's service
calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion
in interface AWSLogs
region
- The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
public AssociateKmsKeyResult associateKmsKey(AssociateKmsKeyRequest request)
AWSLogs
Associates the specified AWS Key Management Service (AWS KMS) customer master key (CMK) with the specified log group.
Associating an AWS KMS CMK with a log group overrides any existing associations between the log group and a CMK. After a CMK is associated with a log group, all newly ingested data for the log group is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs. This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.
Note that it can take up to 5 minutes for this operation to take effect.
If you attempt to associate a CMK with a log group but the CMK does not exist or the CMK is disabled, you will
receive an InvalidParameterException
error.
associateKmsKey
in interface AWSLogs
public CancelExportTaskResult cancelExportTask(CancelExportTaskRequest request)
AWSLogs
Cancels the specified export task.
The task must be in the PENDING
or RUNNING
state.
cancelExportTask
in interface AWSLogs
public CreateExportTaskResult createExportTask(CreateExportTaskRequest request)
AWSLogs
Creates an export task, which allows you to efficiently export data from a log group to an Amazon S3 bucket.
This is an asynchronous call. If all the required information is provided, this operation initiates an export
task and responds with the ID of the task. After the task has started, you can use DescribeExportTasks to
get the status of the export task. Each account can only have one active (RUNNING
or
PENDING
) export task at a time. To cancel an export task, use CancelExportTask.
You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate out log data for each export task, you can specify a prefix to be used as the Amazon S3 key prefix for all exported objects.
createExportTask
in interface AWSLogs
public CreateLogGroupResult createLogGroup(CreateLogGroupRequest request)
AWSLogs
Creates a log group with the specified name.
You can create up to 5000 log groups per account.
You must use the following guidelines when naming a log group:
Log group names must be unique within a region for an AWS account.
Log group names can be between 1 and 512 characters long.
Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).
If you associate a AWS Key Management Service (AWS KMS) customer master key (CMK) with the log group, ingested data is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs. This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.
If you attempt to associate a CMK with the log group but the CMK does not exist or the CMK is disabled, you will
receive an InvalidParameterException
error.
createLogGroup
in interface AWSLogs
public CreateLogStreamResult createLogStream(CreateLogStreamRequest request)
AWSLogs
Creates a log stream for the specified log group.
There is no limit on the number of log streams that you can create for a log group.
You must use the following guidelines when naming a log stream:
Log stream names must be unique within the log group.
Log stream names can be between 1 and 512 characters long.
The ':' (colon) and '*' (asterisk) characters are not allowed.
createLogStream
in interface AWSLogs
public DeleteDestinationResult deleteDestination(DeleteDestinationRequest request)
AWSLogs
Deletes the specified destination, and eventually disables all the subscription filters that publish to it. This operation does not delete the physical resource encapsulated by the destination.
deleteDestination
in interface AWSLogs
public DeleteLogGroupResult deleteLogGroup(DeleteLogGroupRequest request)
AWSLogs
Deletes the specified log group and permanently deletes all the archived log events associated with the log group.
deleteLogGroup
in interface AWSLogs
public DeleteLogStreamResult deleteLogStream(DeleteLogStreamRequest request)
AWSLogs
Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream.
deleteLogStream
in interface AWSLogs
public DeleteMetricFilterResult deleteMetricFilter(DeleteMetricFilterRequest request)
AWSLogs
Deletes the specified metric filter.
deleteMetricFilter
in interface AWSLogs
public DeleteResourcePolicyResult deleteResourcePolicy(DeleteResourcePolicyRequest request)
AWSLogs
Deletes a resource policy from this account. This revokes the access of the identities in that policy to put log events to this account.
deleteResourcePolicy
in interface AWSLogs
public DeleteRetentionPolicyResult deleteRetentionPolicy(DeleteRetentionPolicyRequest request)
AWSLogs
Deletes the specified retention policy.
Log events do not expire if they belong to log groups without a retention policy.
deleteRetentionPolicy
in interface AWSLogs
public DeleteSubscriptionFilterResult deleteSubscriptionFilter(DeleteSubscriptionFilterRequest request)
AWSLogs
Deletes the specified subscription filter.
deleteSubscriptionFilter
in interface AWSLogs
public DescribeDestinationsResult describeDestinations(DescribeDestinationsRequest request)
AWSLogs
Lists all your destinations. The results are ASCII-sorted by destination name.
describeDestinations
in interface AWSLogs
public DescribeDestinationsResult describeDestinations()
AWSLogs
describeDestinations
in interface AWSLogs
AWSLogs.describeDestinations(DescribeDestinationsRequest)
public DescribeExportTasksResult describeExportTasks(DescribeExportTasksRequest request)
AWSLogs
Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.
describeExportTasks
in interface AWSLogs
public DescribeLogGroupsResult describeLogGroups(DescribeLogGroupsRequest request)
AWSLogs
Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name.
describeLogGroups
in interface AWSLogs
public DescribeLogGroupsResult describeLogGroups()
AWSLogs
describeLogGroups
in interface AWSLogs
AWSLogs.describeLogGroups(DescribeLogGroupsRequest)
public DescribeLogStreamsResult describeLogStreams(DescribeLogStreamsRequest request)
AWSLogs
Lists the log streams for the specified log group. You can list all the log streams or filter the results by prefix. You can also control how the results are ordered.
This operation has a limit of five transactions per second, after which transactions are throttled.
describeLogStreams
in interface AWSLogs
public DescribeMetricFiltersResult describeMetricFilters(DescribeMetricFiltersRequest request)
AWSLogs
Lists the specified metric filters. You can list all the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.
describeMetricFilters
in interface AWSLogs
public DescribeResourcePoliciesResult describeResourcePolicies(DescribeResourcePoliciesRequest request)
AWSLogs
Lists the resource policies in this account.
describeResourcePolicies
in interface AWSLogs
public DescribeSubscriptionFiltersResult describeSubscriptionFilters(DescribeSubscriptionFiltersRequest request)
AWSLogs
Lists the subscription filters for the specified log group. You can list all the subscription filters or filter the results by prefix. The results are ASCII-sorted by filter name.
describeSubscriptionFilters
in interface AWSLogs
public DisassociateKmsKeyResult disassociateKmsKey(DisassociateKmsKeyRequest request)
AWSLogs
Disassociates the associated AWS Key Management Service (AWS KMS) customer master key (CMK) from the specified log group.
After the AWS KMS CMK is disassociated from the log group, AWS CloudWatch Logs stops encrypting newly ingested data for the log group. All previously ingested data remains encrypted, and AWS CloudWatch Logs requires permissions for the CMK whenever the encrypted data is requested.
Note that it can take up to 5 minutes for this operation to take effect.
disassociateKmsKey
in interface AWSLogs
public FilterLogEventsResult filterLogEvents(FilterLogEventsRequest request)
AWSLogs
Lists log events from the specified log group. You can list all the log events or filter the results using a filter pattern, a time range, and the name of the log stream.
By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events), or all the events found within the time range that you specify. If the results include a token, then there are more log events available, and you can get additional results by specifying the token in a subsequent call.
filterLogEvents
in interface AWSLogs
public GetLogEventsResult getLogEvents(GetLogEventsRequest request)
AWSLogs
Lists log events from the specified log stream. You can list all the log events or filter using a time range.
By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). You can get additional log events by specifying one of the tokens in a subsequent call.
getLogEvents
in interface AWSLogs
public ListTagsLogGroupResult listTagsLogGroup(ListTagsLogGroupRequest request)
AWSLogs
Lists the tags for the specified log group.
listTagsLogGroup
in interface AWSLogs
public PutDestinationResult putDestination(PutDestinationRequest request)
AWSLogs
Creates or updates a destination. A destination encapsulates a physical resource (such as an Amazon Kinesis stream) and enables you to subscribe to a real-time stream of log events for a different account, ingested using PutLogEvents. Currently, the only supported physical resource is a Kinesis stream belonging to the same account as the destination.
Through an access policy, a destination controls what is written to its Kinesis stream. By default,
PutDestination
does not set any access policy with the destination, which means a cross-account user
cannot call PutSubscriptionFilter against this destination. To enable this, the destination owner must
call PutDestinationPolicy after PutDestination
.
putDestination
in interface AWSLogs
public PutDestinationPolicyResult putDestinationPolicy(PutDestinationPolicyRequest request)
AWSLogs
Creates or updates an access policy associated with an existing destination. An access policy is an IAM policy document that is used to authorize claims to register a subscription filter against a given destination.
putDestinationPolicy
in interface AWSLogs
public PutLogEventsResult putLogEvents(PutLogEventsRequest request)
AWSLogs
Uploads a batch of log events to the specified log stream.
You must include the sequence token obtained from the response of the previous call. An upload in a newly created
log stream does not require a sequence token. You can also get the sequence token using
DescribeLogStreams. If you call PutLogEvents
twice within a narrow time period using the same
value for sequenceToken
, both calls may be successful, or one may be rejected.
The batch of events must satisfy the following constraints:
The maximum batch size is 1,048,576 bytes, and this size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.
None of the log events in the batch can be more than 2 hours in the future.
None of the log events in the batch can be older than 14 days or the retention period of the log group.
The log events in the batch must be in chronological ordered by their time stamp (the time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC).
The maximum number of log events in a batch is 10,000.
A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.
putLogEvents
in interface AWSLogs
public PutMetricFilterResult putMetricFilter(PutMetricFilterRequest request)
AWSLogs
Creates or updates a metric filter and associates it with the specified log group. Metric filters allow you to configure rules to extract metric data from log events ingested through PutLogEvents.
The maximum number of metric filters that can be associated with a log group is 100.
putMetricFilter
in interface AWSLogs
public PutResourcePolicyResult putResourcePolicy(PutResourcePolicyRequest request)
AWSLogs
Creates or updates a resource policy allowing other AWS services to put log events to this account, such as Amazon Route 53. An account can have up to 50 resource policies per region.
putResourcePolicy
in interface AWSLogs
public PutRetentionPolicyResult putRetentionPolicy(PutRetentionPolicyRequest request)
AWSLogs
Sets the retention of the specified log group. A retention policy allows you to configure the number of days for which to retain log events in the specified log group.
putRetentionPolicy
in interface AWSLogs
public PutSubscriptionFilterResult putSubscriptionFilter(PutSubscriptionFilterRequest request)
AWSLogs
Creates or updates a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events ingested through PutLogEvents and have them delivered to a specific destination. Currently, the supported destinations are:
An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.
A logical destination that belongs to a different account, for cross-account delivery.
An Amazon Kinesis Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.
An AWS Lambda function that belongs to the same account as the subscription filter, for same-account delivery.
There can only be one subscription filter associated with a log group. If you are updating an existing filter,
you must specify the correct name in filterName
. Otherwise, the call fails because you cannot
associate a second filter with a log group.
putSubscriptionFilter
in interface AWSLogs
public TagLogGroupResult tagLogGroup(TagLogGroupRequest request)
AWSLogs
Adds or updates the specified tags for the specified log group.
To list the tags for a log group, use ListTagsLogGroup. To remove tags, use UntagLogGroup.
For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs in the Amazon CloudWatch Logs User Guide.
tagLogGroup
in interface AWSLogs
public TestMetricFilterResult testMetricFilter(TestMetricFilterRequest request)
AWSLogs
Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern.
testMetricFilter
in interface AWSLogs
public UntagLogGroupResult untagLogGroup(UntagLogGroupRequest request)
AWSLogs
Removes the specified tags from the specified log group.
To list the tags for a log group, use ListTagsLogGroup. To add tags, use UntagLogGroup.
untagLogGroup
in interface AWSLogs
public void shutdown()
AWSLogs
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSLogs
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AWSLogs
request
- The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.