AWSLogs
Objective-C
@interface AWSLogs
Swift
class AWSLogs
You can use Amazon CloudWatch Logs to monitor, store, and access your log files from EC2 instances, CloudTrail, and other sources. You can then retrieve the associated log data from CloudWatch Logs using the CloudWatch console. Alternatively, you can use CloudWatch Logs commands in the Amazon Web Services CLI, CloudWatch Logs API, or CloudWatch Logs SDK.
You can use CloudWatch Logs to:
Monitor logs from EC2 instances in real time: You can use CloudWatch Logs to monitor applications and systems using log data. For example, CloudWatch Logs can track the number of errors that occur in your application logs. Then, it can send you a notification whenever the rate of errors exceeds a threshold that you specify. CloudWatch Logs uses your log data for monitoring so no code changes are required. For example, you can monitor application logs for specific literal terms (such as “NullReferenceException”). You can also count the number of occurrences of a literal term at a particular position in log data (such as “404” status codes in an Apache access log). When the term you are searching for is found, CloudWatch Logs reports the data to a CloudWatch metric that you specify.
Monitor CloudTrail logged events: You can create alarms in CloudWatch and receive notifications of particular API activity as captured by CloudTrail. You can use the notification to perform troubleshooting.
Archive log data: You can use CloudWatch Logs to store your log data in highly durable storage. You can change the log retention setting so that any log events earlier than this setting are automatically deleted. The CloudWatch Logs agent helps to quickly send both rotated and non-rotated log data off of a host and into the log service. You can then access the raw log data when you need it.
-
The service configuration used to instantiate this service client.
Warning
Once the client is instantiated, do not modify the configuration object. It may cause unspecified behaviors.Declaration
Objective-C
@property (nonatomic, strong, readonly) AWSServiceConfiguration *configuration
-
Returns the singleton service client. If the singleton object does not exist, the SDK instantiates the default service client with
defaultServiceConfiguration
from[AWSServiceManager defaultServiceManager]
. The reference to this object is maintained by the SDK, and you do not need to retain it manually.For example, set the default service configuration in
- application:didFinishLaunchingWithOptions:
Swift
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool { let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") let configuration = AWSServiceConfiguration(region: .USEast1, credentialsProvider: credentialProvider) AWSServiceManager.default().defaultServiceConfiguration = configuration return true
}
Objective-C
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 identityPoolId:@"YourIdentityPoolId"]; AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSEast1 credentialsProvider:credentialsProvider]; [AWSServiceManager defaultServiceManager].defaultServiceConfiguration = configuration; return YES; }
Then call the following to get the default service client:
Swift
let Logs = AWSLogs.default()
Objective-C
AWSLogs *Logs = [AWSLogs defaultLogs];
Declaration
Objective-C
+ (nonnull instancetype)defaultLogs;
Swift
class func `default`() -> Self
Return Value
The default service client.
-
Creates a service client with the given service configuration and registers it for the key.
For example, set the default service configuration in
- application:didFinishLaunchingWithOptions:
Swift
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool { let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider) AWSLogs.register(with: configuration!, forKey: "USWest2Logs") return true
}
Objective-C
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 identityPoolId:@"YourIdentityPoolId"]; AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2 credentialsProvider:credentialsProvider]; [AWSLogs registerLogsWithConfiguration:configuration forKey:@"USWest2Logs"]; return YES; }
Then call the following to get the service client:
Swift
let Logs = AWSLogs(forKey: "USWest2Logs")
Objective-C
AWSLogs *Logs = [AWSLogs LogsForKey:@"USWest2Logs"];
Warning
After calling this method, do not modify the configuration object. It may cause unspecified behaviors.
Declaration
Objective-C
+ (void)registerLogsWithConfiguration:(id)configuration forKey:(nonnull NSString *)key;
Swift
class func register(withConfiguration configuration: Any!, forKey key: String)
Parameters
configuration
A service configuration object.
key
A string to identify the service client.
-
Retrieves the service client associated with the key. You need to call
+ registerLogsWithConfiguration:forKey:
before invoking this method.For example, set the default service configuration in
- application:didFinishLaunchingWithOptions:
Swift
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool { let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider) AWSLogs.register(with: configuration!, forKey: "USWest2Logs") return true
}
Objective-C
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 identityPoolId:@"YourIdentityPoolId"]; AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2 credentialsProvider:credentialsProvider]; [AWSLogs registerLogsWithConfiguration:configuration forKey:@"USWest2Logs"]; return YES; }
Then call the following to get the service client:
Swift
let Logs = AWSLogs(forKey: "USWest2Logs")
Objective-C
AWSLogs *Logs = [AWSLogs LogsForKey:@"USWest2Logs"];
Declaration
Objective-C
+ (nonnull instancetype)LogsForKey:(nonnull NSString *)key;
Swift
convenience init(forKey key: String)
Parameters
key
A string to identify the service client.
Return Value
An instance of the service client.
-
Removes the service client associated with the key and release it.
Warning
Before calling this method, make sure no method is running on this client.
Declaration
Objective-C
+ (void)removeLogsForKey:(nonnull NSString *)key;
Swift
class func remove(forKey key: String)
Parameters
key
A string to identify the service client.
-
Associates the specified KMS key with either one log group in the account, or with all stored CloudWatch Logs query insights results in the account.
When you use
AssociateKmsKey
, you specify either thelogGroupName
parameter or theresourceIdentifier
parameter. You can’t specify both of those parameters in the same operation.Specify the
logGroupName
parameter to cause all log events stored in the log group to be encrypted with that key. Only the log events ingested after the key is associated are encrypted with that key.Associating a KMS key with a log group overrides any existing associations between the log group and a KMS key. After a KMS key is associated with a log group, all newly ingested data for the log group is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.
Associating a key with a log group does not cause the results of queries of that log group to be encrypted with that key. To have query results encrypted with a KMS key, you must use an
AssociateKmsKey
operation with theresourceIdentifier
parameter that specifies aquery-result
resource.Specify the
resourceIdentifier
parameter with aquery-result
resource, to use that key to encrypt the stored results of all future StartQuery operations in the account. The response from a GetQueryResults operation will still return the query results in plain text.Even if you have not associated a key with your query results, the query results are encrypted when stored, using the default CloudWatch Logs method.
If you run a query from a monitoring account that queries logs in a source account, the query results key from the monitoring account, if any, is used.
If you delete the key that is used to encrypt log events or log group query results, then all the associated stored log events or query results that were encrypted with that key will be unencryptable and unusable.
CloudWatch Logs supports only symmetric KMS keys. Do not use an associate an asymmetric KMS key with your log group or query results. For more information, see Using Symmetric and Asymmetric Keys.
It can take up to 5 minutes for this operation to take effect.
If you attempt to associate a KMS key with a log group but the KMS key does not exist or the KMS key is disabled, you receive an
InvalidParameterException
error.See
AWSLogsAssociateKmsKeyRequest
Declaration
Objective-C
- (id)associateKmsKey:(nonnull AWSLogsAssociateKmsKeyRequest *)request;
Swift
func associateKmsKey(_ request: AWSLogsAssociateKmsKeyRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AssociateKmsKey service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorOperationAborted
,AWSLogsErrorServiceUnavailable
. -
Associates the specified KMS key with either one log group in the account, or with all stored CloudWatch Logs query insights results in the account.
When you use
AssociateKmsKey
, you specify either thelogGroupName
parameter or theresourceIdentifier
parameter. You can’t specify both of those parameters in the same operation.Specify the
logGroupName
parameter to cause all log events stored in the log group to be encrypted with that key. Only the log events ingested after the key is associated are encrypted with that key.Associating a KMS key with a log group overrides any existing associations between the log group and a KMS key. After a KMS key is associated with a log group, all newly ingested data for the log group is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.
Associating a key with a log group does not cause the results of queries of that log group to be encrypted with that key. To have query results encrypted with a KMS key, you must use an
AssociateKmsKey
operation with theresourceIdentifier
parameter that specifies aquery-result
resource.Specify the
resourceIdentifier
parameter with aquery-result
resource, to use that key to encrypt the stored results of all future StartQuery operations in the account. The response from a GetQueryResults operation will still return the query results in plain text.Even if you have not associated a key with your query results, the query results are encrypted when stored, using the default CloudWatch Logs method.
If you run a query from a monitoring account that queries logs in a source account, the query results key from the monitoring account, if any, is used.
If you delete the key that is used to encrypt log events or log group query results, then all the associated stored log events or query results that were encrypted with that key will be unencryptable and unusable.
CloudWatch Logs supports only symmetric KMS keys. Do not use an associate an asymmetric KMS key with your log group or query results. For more information, see Using Symmetric and Asymmetric Keys.
It can take up to 5 minutes for this operation to take effect.
If you attempt to associate a KMS key with a log group but the KMS key does not exist or the KMS key is disabled, you receive an
InvalidParameterException
error.See
AWSLogsAssociateKmsKeyRequest
Declaration
Objective-C
- (void)associateKmsKey:(nonnull AWSLogsAssociateKmsKeyRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func associateKmsKey(_ request: AWSLogsAssociateKmsKeyRequest) async throws
Parameters
request
A container for the necessary parameters to execute the AssociateKmsKey service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorOperationAborted
,AWSLogsErrorServiceUnavailable
. -
Cancels the specified export task.
The task must be in the
PENDING
orRUNNING
state.See
AWSLogsCancelExportTaskRequest
Declaration
Objective-C
- (id)cancelExportTask:(nonnull AWSLogsCancelExportTaskRequest *)request;
Swift
func cancelExportTask(_ request: AWSLogsCancelExportTaskRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CancelExportTask service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorInvalidOperation
,AWSLogsErrorServiceUnavailable
. -
Cancels the specified export task.
The task must be in the
PENDING
orRUNNING
state.See
AWSLogsCancelExportTaskRequest
Declaration
Objective-C
- (void)cancelExportTask:(nonnull AWSLogsCancelExportTaskRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func cancelExportTask(_ request: AWSLogsCancelExportTaskRequest) async throws
Parameters
request
A container for the necessary parameters to execute the CancelExportTask service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorInvalidOperation
,AWSLogsErrorServiceUnavailable
. -
Creates a delivery. A delivery is a connection between a logical delivery source and a logical delivery destination that you have already created.
Only some Amazon Web Services services support being configured as a delivery source using this operation. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services.
A delivery destination can represent a log group in CloudWatch Logs, an Amazon S3 bucket, or a delivery stream in Firehose.
To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following:
Create a delivery source, which is a logical object that represents the resource that is actually sending the logs. For more information, see PutDeliverySource.
Create a delivery destination, which is a logical object that represents the actual delivery destination. For more information, see PutDeliveryDestination.
If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.
Use
CreateDelivery
to create a delivery by pairing exactly one delivery source and one delivery destination.
You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.
You can’t update an existing delivery. You can only create and delete deliveries.
See
AWSLogsCreateDeliveryRequest
See
AWSLogsCreateDeliveryResponse
Declaration
Objective-C
- (id)createDelivery:(nonnull AWSLogsCreateDeliveryRequest *)request;
Swift
func createDelivery(_ request: AWSLogsCreateDeliveryRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateDelivery service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsCreateDeliveryResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorServiceUnavailable
,AWSLogsErrorConflict
,AWSLogsErrorResourceNotFound
,AWSLogsErrorValidation
,AWSLogsErrorAccessDenied
,AWSLogsErrorServiceQuotaExceeded
,AWSLogsErrorThrottling
. -
Creates a delivery. A delivery is a connection between a logical delivery source and a logical delivery destination that you have already created.
Only some Amazon Web Services services support being configured as a delivery source using this operation. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services.
A delivery destination can represent a log group in CloudWatch Logs, an Amazon S3 bucket, or a delivery stream in Firehose.
To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following:
Create a delivery source, which is a logical object that represents the resource that is actually sending the logs. For more information, see PutDeliverySource.
Create a delivery destination, which is a logical object that represents the actual delivery destination. For more information, see PutDeliveryDestination.
If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.
Use
CreateDelivery
to create a delivery by pairing exactly one delivery source and one delivery destination.
You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.
You can’t update an existing delivery. You can only create and delete deliveries.
See
AWSLogsCreateDeliveryRequest
See
AWSLogsCreateDeliveryResponse
Declaration
Objective-C
- (void)createDelivery:(nonnull AWSLogsCreateDeliveryRequest *)request completionHandler: (void (^_Nullable)(AWSLogsCreateDeliveryResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func createDelivery(_ request: AWSLogsCreateDeliveryRequest) async throws -> AWSLogsCreateDeliveryResponse
Parameters
request
A container for the necessary parameters to execute the CreateDelivery service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorServiceUnavailable
,AWSLogsErrorConflict
,AWSLogsErrorResourceNotFound
,AWSLogsErrorValidation
,AWSLogsErrorAccessDenied
,AWSLogsErrorServiceQuotaExceeded
,AWSLogsErrorThrottling
. -
Creates an export task so that you can efficiently export data from a log group to an Amazon S3 bucket. When you perform a
CreateExportTask
operation, you must use credentials that have permission to write to the S3 bucket that you specify as the destination.Exporting log data to S3 buckets that are encrypted by KMS is supported. Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is also supported.
Exporting to S3 buckets that are encrypted with AES-256 is supported.
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
orPENDING
) 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 log data for each export task, specify a prefix to be used as the Amazon S3 key prefix for all exported objects.
Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can sort the exported log field data by using Linux utilities.
See
AWSLogsCreateExportTaskRequest
See
AWSLogsCreateExportTaskResponse
Declaration
Objective-C
- (id)createExportTask:(nonnull AWSLogsCreateExportTaskRequest *)request;
Swift
func createExportTask(_ request: AWSLogsCreateExportTaskRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateExportTask service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsCreateExportTaskResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorLimitExceeded
,AWSLogsErrorOperationAborted
,AWSLogsErrorServiceUnavailable
,AWSLogsErrorResourceNotFound
,AWSLogsErrorResourceAlreadyExists
. -
Creates an export task so that you can efficiently export data from a log group to an Amazon S3 bucket. When you perform a
CreateExportTask
operation, you must use credentials that have permission to write to the S3 bucket that you specify as the destination.Exporting log data to S3 buckets that are encrypted by KMS is supported. Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is also supported.
Exporting to S3 buckets that are encrypted with AES-256 is supported.
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
orPENDING
) 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 log data for each export task, specify a prefix to be used as the Amazon S3 key prefix for all exported objects.
Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can sort the exported log field data by using Linux utilities.
See
AWSLogsCreateExportTaskRequest
See
AWSLogsCreateExportTaskResponse
Declaration
Objective-C
- (void)createExportTask:(nonnull AWSLogsCreateExportTaskRequest *)request completionHandler: (void (^_Nullable)(AWSLogsCreateExportTaskResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func createExportTask(_ request: AWSLogsCreateExportTaskRequest) async throws -> AWSLogsCreateExportTaskResponse
Parameters
request
A container for the necessary parameters to execute the CreateExportTask service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorLimitExceeded
,AWSLogsErrorOperationAborted
,AWSLogsErrorServiceUnavailable
,AWSLogsErrorResourceNotFound
,AWSLogsErrorResourceAlreadyExists
. -
Creates an anomaly detector that regularly scans one or more log groups and look for patterns and anomalies in the logs.
An anomaly detector can help surface issues by automatically discovering anomalies in your log event traffic. An anomaly detector uses machine learning algorithms to scan log events and find patterns. A pattern is a shared text structure that recurs among your log fields. Patterns provide a useful tool for analyzing large sets of logs because a large number of log events can often be compressed into a few patterns.
The anomaly detector uses pattern recognition to find
anomalies
, which are unusual log events. It uses theevaluationFrequency
to compare current log events and patterns with trained baselines.Fields within a pattern are called tokens. Fields that vary within a pattern, such as a request ID or timestamp, are referred to as dynamic tokens and represented by
<>
.The following is an example of a pattern:
[INFO] Request time: <> ms
This pattern represents log events like
[INFO] Request time: 327 ms
and other similar log events that differ only by the number, in this csse 327. When the pattern is displayed, the different numbers are replaced by<*>
Any parts of log events that are masked as sensitive data are not scanned for anomalies. For more information about masking sensitive data, see Help protect sensitive log data with masking.
See
AWSLogsCreateLogAnomalyDetectorRequest
See
AWSLogsCreateLogAnomalyDetectorResponse
Declaration
Objective-C
- (id)createLogAnomalyDetector: (nonnull AWSLogsCreateLogAnomalyDetectorRequest *)request;
Swift
func createLogAnomalyDetector(_ request: AWSLogsCreateLogAnomalyDetectorRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateLogAnomalyDetector service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsCreateLogAnomalyDetectorResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
,AWSLogsErrorOperationAborted
,AWSLogsErrorLimitExceeded
. -
Creates an anomaly detector that regularly scans one or more log groups and look for patterns and anomalies in the logs.
An anomaly detector can help surface issues by automatically discovering anomalies in your log event traffic. An anomaly detector uses machine learning algorithms to scan log events and find patterns. A pattern is a shared text structure that recurs among your log fields. Patterns provide a useful tool for analyzing large sets of logs because a large number of log events can often be compressed into a few patterns.
The anomaly detector uses pattern recognition to find
anomalies
, which are unusual log events. It uses theevaluationFrequency
to compare current log events and patterns with trained baselines.Fields within a pattern are called tokens. Fields that vary within a pattern, such as a request ID or timestamp, are referred to as dynamic tokens and represented by
<>
.The following is an example of a pattern:
[INFO] Request time: <> ms
This pattern represents log events like
[INFO] Request time: 327 ms
and other similar log events that differ only by the number, in this csse 327. When the pattern is displayed, the different numbers are replaced by<*>
Any parts of log events that are masked as sensitive data are not scanned for anomalies. For more information about masking sensitive data, see Help protect sensitive log data with masking.
See
AWSLogsCreateLogAnomalyDetectorRequest
See
AWSLogsCreateLogAnomalyDetectorResponse
Declaration
Objective-C
- (void)createLogAnomalyDetector: (nonnull AWSLogsCreateLogAnomalyDetectorRequest *)request completionHandler: (void (^_Nullable)( AWSLogsCreateLogAnomalyDetectorResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func createLogAnomalyDetector(_ request: AWSLogsCreateLogAnomalyDetectorRequest) async throws -> AWSLogsCreateLogAnomalyDetectorResponse
Parameters
request
A container for the necessary parameters to execute the CreateLogAnomalyDetector service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
,AWSLogsErrorOperationAborted
,AWSLogsErrorLimitExceeded
. -
Creates a log group with the specified name. You can create up to 1,000,000 log groups per Region per account.
You must use the following guidelines when naming a log group:
Log group names must be unique within a Region for an Amazon Web Services 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), ‘.’ (period), and ‘#’ (number sign)
Log group names can’t start with the string
aws/
When you create a log group, by default the log events in the log group do not expire. To set a retention policy so that events expire and are deleted after a specified time, use PutRetentionPolicy.
If you associate an KMS key with the log group, ingested data is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.
If you attempt to associate a KMS key with the log group but the KMS key does not exist or the KMS key is disabled, you receive an
InvalidParameterException
error.CloudWatch Logs supports only symmetric KMS keys. Do not associate an asymmetric KMS key with your log group. For more information, see Using Symmetric and Asymmetric Keys.
See
AWSLogsCreateLogGroupRequest
Declaration
Objective-C
- (id)createLogGroup:(nonnull AWSLogsCreateLogGroupRequest *)request;
Swift
func createLogGroup(_ request: AWSLogsCreateLogGroupRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateLogGroup service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceAlreadyExists
,AWSLogsErrorLimitExceeded
,AWSLogsErrorOperationAborted
,AWSLogsErrorServiceUnavailable
. -
Creates a log group with the specified name. You can create up to 1,000,000 log groups per Region per account.
You must use the following guidelines when naming a log group:
Log group names must be unique within a Region for an Amazon Web Services 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), ‘.’ (period), and ‘#’ (number sign)
Log group names can’t start with the string
aws/
When you create a log group, by default the log events in the log group do not expire. To set a retention policy so that events expire and are deleted after a specified time, use PutRetentionPolicy.
If you associate an KMS key with the log group, ingested data is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.
If you attempt to associate a KMS key with the log group but the KMS key does not exist or the KMS key is disabled, you receive an
InvalidParameterException
error.CloudWatch Logs supports only symmetric KMS keys. Do not associate an asymmetric KMS key with your log group. For more information, see Using Symmetric and Asymmetric Keys.
See
AWSLogsCreateLogGroupRequest
Declaration
Objective-C
- (void)createLogGroup:(nonnull AWSLogsCreateLogGroupRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func createLogGroup(_ request: AWSLogsCreateLogGroupRequest) async throws
Parameters
request
A container for the necessary parameters to execute the CreateLogGroup service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceAlreadyExists
,AWSLogsErrorLimitExceeded
,AWSLogsErrorOperationAborted
,AWSLogsErrorServiceUnavailable
. -
Creates a log stream for the specified log group. A log stream is a sequence of log events that originate from a single source, such as an application instance or a resource that is being monitored.
There is no limit on the number of log streams that you can create for a log group. There is a limit of 50 TPS on
CreateLogStream
operations, after which transactions are throttled.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.
Don’t use ‘:’ (colon) or ‘*’ (asterisk) characters.
See
AWSLogsCreateLogStreamRequest
Declaration
Objective-C
- (id)createLogStream:(nonnull AWSLogsCreateLogStreamRequest *)request;
Swift
func createLogStream(_ request: AWSLogsCreateLogStreamRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateLogStream service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceAlreadyExists
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
Creates a log stream for the specified log group. A log stream is a sequence of log events that originate from a single source, such as an application instance or a resource that is being monitored.
There is no limit on the number of log streams that you can create for a log group. There is a limit of 50 TPS on
CreateLogStream
operations, after which transactions are throttled.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.
Don’t use ‘:’ (colon) or ‘*’ (asterisk) characters.
See
AWSLogsCreateLogStreamRequest
Declaration
Objective-C
- (void)createLogStream:(nonnull AWSLogsCreateLogStreamRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func createLogStream(_ request: AWSLogsCreateLogStreamRequest) async throws
Parameters
request
A container for the necessary parameters to execute the CreateLogStream service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceAlreadyExists
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
Deletes a CloudWatch Logs account policy. This stops the policy from applying to all log groups or a subset of log groups in the account. Log-group level policies will still be in effect.
To use this operation, you must be signed on with the correct permissions depending on the type of policy that you are deleting.
To delete a data protection policy, you must have the
logs:DeleteDataProtectionPolicy
andlogs:DeleteAccountPolicy
permissions.To delete a subscription filter policy, you must have the
logs:DeleteSubscriptionFilter
andlogs:DeleteAccountPolicy
permissions.
See
AWSLogsDeleteAccountPolicyRequest
Declaration
Objective-C
- (id)deleteAccountPolicy:(nonnull AWSLogsDeleteAccountPolicyRequest *)request;
Swift
func deleteAccountPolicy(_ request: AWSLogsDeleteAccountPolicyRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteAccountPolicy service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
,AWSLogsErrorOperationAborted
. -
Deletes a CloudWatch Logs account policy. This stops the policy from applying to all log groups or a subset of log groups in the account. Log-group level policies will still be in effect.
To use this operation, you must be signed on with the correct permissions depending on the type of policy that you are deleting.
To delete a data protection policy, you must have the
logs:DeleteDataProtectionPolicy
andlogs:DeleteAccountPolicy
permissions.To delete a subscription filter policy, you must have the
logs:DeleteSubscriptionFilter
andlogs:DeleteAccountPolicy
permissions.
See
AWSLogsDeleteAccountPolicyRequest
Declaration
Objective-C
- (void)deleteAccountPolicy:(nonnull AWSLogsDeleteAccountPolicyRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func deleteAccountPolicy(_ request: AWSLogsDeleteAccountPolicyRequest) async throws
Parameters
request
A container for the necessary parameters to execute the DeleteAccountPolicy service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
,AWSLogsErrorOperationAborted
. -
Deletes the data protection policy from the specified log group.
For more information about data protection policies, see PutDataProtectionPolicy.
See
AWSLogsDeleteDataProtectionPolicyRequest
Declaration
Objective-C
- (id)deleteDataProtectionPolicy: (nonnull AWSLogsDeleteDataProtectionPolicyRequest *)request;
Swift
func deleteDataProtectionPolicy(_ request: AWSLogsDeleteDataProtectionPolicyRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteDataProtectionPolicy service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorOperationAborted
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
Deletes the data protection policy from the specified log group.
For more information about data protection policies, see PutDataProtectionPolicy.
See
AWSLogsDeleteDataProtectionPolicyRequest
Declaration
Objective-C
- (void)deleteDataProtectionPolicy: (nonnull AWSLogsDeleteDataProtectionPolicyRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func deleteDataProtectionPolicy(_ request: AWSLogsDeleteDataProtectionPolicyRequest) async throws
Parameters
request
A container for the necessary parameters to execute the DeleteDataProtectionPolicy service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorOperationAborted
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
Deletes s delivery. A delivery is a connection between a logical delivery source and a logical delivery destination. Deleting a delivery only deletes the connection between the delivery source and delivery destination. It does not delete the delivery destination or the delivery source.
See
AWSLogsDeleteDeliveryRequest
Declaration
Objective-C
- (id)deleteDelivery:(nonnull AWSLogsDeleteDeliveryRequest *)request;
Swift
func deleteDelivery(_ request: AWSLogsDeleteDeliveryRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteDelivery service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
,AWSLogsErrorConflict
,AWSLogsErrorValidation
,AWSLogsErrorServiceQuotaExceeded
,AWSLogsErrorThrottling
. -
Deletes s delivery. A delivery is a connection between a logical delivery source and a logical delivery destination. Deleting a delivery only deletes the connection between the delivery source and delivery destination. It does not delete the delivery destination or the delivery source.
See
AWSLogsDeleteDeliveryRequest
Declaration
Objective-C
- (void)deleteDelivery:(nonnull AWSLogsDeleteDeliveryRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func deleteDelivery(_ request: AWSLogsDeleteDeliveryRequest) async throws
Parameters
request
A container for the necessary parameters to execute the DeleteDelivery service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
,AWSLogsErrorConflict
,AWSLogsErrorValidation
,AWSLogsErrorServiceQuotaExceeded
,AWSLogsErrorThrottling
. -
Deletes a delivery destination. A delivery is a connection between a logical delivery source and a logical delivery destination.
You can’t delete a delivery destination if any current deliveries are associated with it. To find whether any deliveries are associated with this delivery destination, use the DescribeDeliveries operation and check the
deliveryDestinationArn
field in the results.See
AWSLogsDeleteDeliveryDestinationRequest
Declaration
Objective-C
- (id)deleteDeliveryDestination: (nonnull AWSLogsDeleteDeliveryDestinationRequest *)request;
Swift
func deleteDeliveryDestination(_ request: AWSLogsDeleteDeliveryDestinationRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteDeliveryDestination service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
,AWSLogsErrorConflict
,AWSLogsErrorValidation
,AWSLogsErrorServiceQuotaExceeded
,AWSLogsErrorThrottling
. -
Deletes a delivery destination. A delivery is a connection between a logical delivery source and a logical delivery destination.
You can’t delete a delivery destination if any current deliveries are associated with it. To find whether any deliveries are associated with this delivery destination, use the DescribeDeliveries operation and check the
deliveryDestinationArn
field in the results.See
AWSLogsDeleteDeliveryDestinationRequest
Declaration
Objective-C
- (void)deleteDeliveryDestination: (nonnull AWSLogsDeleteDeliveryDestinationRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func deleteDeliveryDestination(_ request: AWSLogsDeleteDeliveryDestinationRequest) async throws
Parameters
request
A container for the necessary parameters to execute the DeleteDeliveryDestination service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
,AWSLogsErrorConflict
,AWSLogsErrorValidation
,AWSLogsErrorServiceQuotaExceeded
,AWSLogsErrorThrottling
. -
Deletes a delivery destination policy. For more information about these policies, see PutDeliveryDestinationPolicy.
See
AWSLogsDeleteDeliveryDestinationPolicyRequest
Declaration
Objective-C
- (id)deleteDeliveryDestinationPolicy: (nonnull AWSLogsDeleteDeliveryDestinationPolicyRequest *)request;
Swift
func deleteDeliveryDestinationPolicy(_ request: AWSLogsDeleteDeliveryDestinationPolicyRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteDeliveryDestinationPolicy service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorServiceUnavailable
,AWSLogsErrorValidation
,AWSLogsErrorResourceNotFound
,AWSLogsErrorConflict
. -
Deletes a delivery destination policy. For more information about these policies, see PutDeliveryDestinationPolicy.
See
AWSLogsDeleteDeliveryDestinationPolicyRequest
Declaration
Objective-C
- (void)deleteDeliveryDestinationPolicy: (nonnull AWSLogsDeleteDeliveryDestinationPolicyRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable)) completionHandler;
Swift
func deleteDeliveryDestinationPolicy(_ request: AWSLogsDeleteDeliveryDestinationPolicyRequest) async throws
Parameters
request
A container for the necessary parameters to execute the DeleteDeliveryDestinationPolicy service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorServiceUnavailable
,AWSLogsErrorValidation
,AWSLogsErrorResourceNotFound
,AWSLogsErrorConflict
. -
Deletes a delivery source. A delivery is a connection between a logical delivery source and a logical delivery destination.
You can’t delete a delivery source if any current deliveries are associated with it. To find whether any deliveries are associated with this delivery source, use the DescribeDeliveries operation and check the
deliverySourceName
field in the results.See
AWSLogsDeleteDeliverySourceRequest
Declaration
Objective-C
- (id)deleteDeliverySource: (nonnull AWSLogsDeleteDeliverySourceRequest *)request;
Swift
func deleteDeliverySource(_ request: AWSLogsDeleteDeliverySourceRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteDeliverySource service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
,AWSLogsErrorConflict
,AWSLogsErrorValidation
,AWSLogsErrorServiceQuotaExceeded
,AWSLogsErrorThrottling
. -
Deletes a delivery source. A delivery is a connection between a logical delivery source and a logical delivery destination.
You can’t delete a delivery source if any current deliveries are associated with it. To find whether any deliveries are associated with this delivery source, use the DescribeDeliveries operation and check the
deliverySourceName
field in the results.See
AWSLogsDeleteDeliverySourceRequest
Declaration
Objective-C
- (void)deleteDeliverySource: (nonnull AWSLogsDeleteDeliverySourceRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func deleteDeliverySource(_ request: AWSLogsDeleteDeliverySourceRequest) async throws
Parameters
request
A container for the necessary parameters to execute the DeleteDeliverySource service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
,AWSLogsErrorConflict
,AWSLogsErrorValidation
,AWSLogsErrorServiceQuotaExceeded
,AWSLogsErrorThrottling
. -
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.
See
AWSLogsDeleteDestinationRequest
Declaration
Objective-C
- (id)deleteDestination:(nonnull AWSLogsDeleteDestinationRequest *)request;
Swift
func deleteDestination(_ request: AWSLogsDeleteDestinationRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteDestination service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorOperationAborted
,AWSLogsErrorServiceUnavailable
. -
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.
See
AWSLogsDeleteDestinationRequest
Declaration
Objective-C
- (void)deleteDestination:(nonnull AWSLogsDeleteDestinationRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func deleteDestination(_ request: AWSLogsDeleteDestinationRequest) async throws
Parameters
request
A container for the necessary parameters to execute the DeleteDestination service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorOperationAborted
,AWSLogsErrorServiceUnavailable
. -
Deletes the specified CloudWatch Logs anomaly detector.
See
AWSLogsDeleteLogAnomalyDetectorRequest
Declaration
Objective-C
- (id)deleteLogAnomalyDetector: (nonnull AWSLogsDeleteLogAnomalyDetectorRequest *)request;
Swift
func deleteLogAnomalyDetector(_ request: AWSLogsDeleteLogAnomalyDetectorRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteLogAnomalyDetector service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
,AWSLogsErrorOperationAborted
. -
Deletes the specified CloudWatch Logs anomaly detector.
See
AWSLogsDeleteLogAnomalyDetectorRequest
Declaration
Objective-C
- (void)deleteLogAnomalyDetector: (nonnull AWSLogsDeleteLogAnomalyDetectorRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func deleteLogAnomalyDetector(_ request: AWSLogsDeleteLogAnomalyDetectorRequest) async throws
Parameters
request
A container for the necessary parameters to execute the DeleteLogAnomalyDetector service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
,AWSLogsErrorOperationAborted
. -
Deletes the specified log group and permanently deletes all the archived log events associated with the log group.
See
AWSLogsDeleteLogGroupRequest
Declaration
Objective-C
- (id)deleteLogGroup:(nonnull AWSLogsDeleteLogGroupRequest *)request;
Swift
func deleteLogGroup(_ request: AWSLogsDeleteLogGroupRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteLogGroup service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorOperationAborted
,AWSLogsErrorServiceUnavailable
. -
Deletes the specified log group and permanently deletes all the archived log events associated with the log group.
See
AWSLogsDeleteLogGroupRequest
Declaration
Objective-C
- (void)deleteLogGroup:(nonnull AWSLogsDeleteLogGroupRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func deleteLogGroup(_ request: AWSLogsDeleteLogGroupRequest) async throws
Parameters
request
A container for the necessary parameters to execute the DeleteLogGroup service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorOperationAborted
,AWSLogsErrorServiceUnavailable
. -
Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream.
See
AWSLogsDeleteLogStreamRequest
Declaration
Objective-C
- (id)deleteLogStream:(nonnull AWSLogsDeleteLogStreamRequest *)request;
Swift
func deleteLogStream(_ request: AWSLogsDeleteLogStreamRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteLogStream service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorOperationAborted
,AWSLogsErrorServiceUnavailable
. -
Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream.
See
AWSLogsDeleteLogStreamRequest
Declaration
Objective-C
- (void)deleteLogStream:(nonnull AWSLogsDeleteLogStreamRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func deleteLogStream(_ request: AWSLogsDeleteLogStreamRequest) async throws
Parameters
request
A container for the necessary parameters to execute the DeleteLogStream service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorOperationAborted
,AWSLogsErrorServiceUnavailable
. -
Deletes the specified metric filter.
See
AWSLogsDeleteMetricFilterRequest
Declaration
Objective-C
- (id)deleteMetricFilter:(nonnull AWSLogsDeleteMetricFilterRequest *)request;
Swift
func deleteMetricFilter(_ request: AWSLogsDeleteMetricFilterRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteMetricFilter service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorOperationAborted
,AWSLogsErrorServiceUnavailable
. -
Deletes the specified metric filter.
See
AWSLogsDeleteMetricFilterRequest
Declaration
Objective-C
- (void)deleteMetricFilter:(nonnull AWSLogsDeleteMetricFilterRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func deleteMetricFilter(_ request: AWSLogsDeleteMetricFilterRequest) async throws
Parameters
request
A container for the necessary parameters to execute the DeleteMetricFilter service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorOperationAborted
,AWSLogsErrorServiceUnavailable
. -
Deletes a saved CloudWatch Logs Insights query definition. A query definition contains details about a saved CloudWatch Logs Insights query.
Each
DeleteQueryDefinition
operation can delete one query definition.You must have the
logs:DeleteQueryDefinition
permission to be able to perform this operation.See
AWSLogsDeleteQueryDefinitionRequest
See
AWSLogsDeleteQueryDefinitionResponse
Declaration
Objective-C
- (id)deleteQueryDefinition: (nonnull AWSLogsDeleteQueryDefinitionRequest *)request;
Swift
func deleteQueryDefinition(_ request: AWSLogsDeleteQueryDefinitionRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteQueryDefinition service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsDeleteQueryDefinitionResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
Deletes a saved CloudWatch Logs Insights query definition. A query definition contains details about a saved CloudWatch Logs Insights query.
Each
DeleteQueryDefinition
operation can delete one query definition.You must have the
logs:DeleteQueryDefinition
permission to be able to perform this operation.See
AWSLogsDeleteQueryDefinitionRequest
See
AWSLogsDeleteQueryDefinitionResponse
Declaration
Objective-C
- (void) deleteQueryDefinition:(nonnull AWSLogsDeleteQueryDefinitionRequest *)request completionHandler: (void (^_Nullable)(AWSLogsDeleteQueryDefinitionResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func deleteQueryDefinition(_ request: AWSLogsDeleteQueryDefinitionRequest) async throws -> AWSLogsDeleteQueryDefinitionResponse
Parameters
request
A container for the necessary parameters to execute the DeleteQueryDefinition service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
Deletes a resource policy from this account. This revokes the access of the identities in that policy to put log events to this account.
See
AWSLogsDeleteResourcePolicyRequest
Declaration
Objective-C
- (id)deleteResourcePolicy: (nonnull AWSLogsDeleteResourcePolicyRequest *)request;
Swift
func deleteResourcePolicy(_ request: AWSLogsDeleteResourcePolicyRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteResourcePolicy service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
Deletes a resource policy from this account. This revokes the access of the identities in that policy to put log events to this account.
See
AWSLogsDeleteResourcePolicyRequest
Declaration
Objective-C
- (void)deleteResourcePolicy: (nonnull AWSLogsDeleteResourcePolicyRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func deleteResourcePolicy(_ request: AWSLogsDeleteResourcePolicyRequest) async throws
Parameters
request
A container for the necessary parameters to execute the DeleteResourcePolicy service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
Deletes the specified retention policy.
Log events do not expire if they belong to log groups without a retention policy.
See
AWSLogsDeleteRetentionPolicyRequest
Declaration
Objective-C
- (id)deleteRetentionPolicy: (nonnull AWSLogsDeleteRetentionPolicyRequest *)request;
Swift
func deleteRetentionPolicy(_ request: AWSLogsDeleteRetentionPolicyRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteRetentionPolicy service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorOperationAborted
,AWSLogsErrorServiceUnavailable
. -
Deletes the specified retention policy.
Log events do not expire if they belong to log groups without a retention policy.
See
AWSLogsDeleteRetentionPolicyRequest
Declaration
Objective-C
- (void)deleteRetentionPolicy: (nonnull AWSLogsDeleteRetentionPolicyRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func deleteRetentionPolicy(_ request: AWSLogsDeleteRetentionPolicyRequest) async throws
Parameters
request
A container for the necessary parameters to execute the DeleteRetentionPolicy service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorOperationAborted
,AWSLogsErrorServiceUnavailable
. -
Deletes the specified subscription filter.
See
AWSLogsDeleteSubscriptionFilterRequest
Declaration
Objective-C
- (id)deleteSubscriptionFilter: (nonnull AWSLogsDeleteSubscriptionFilterRequest *)request;
Swift
func deleteSubscriptionFilter(_ request: AWSLogsDeleteSubscriptionFilterRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteSubscriptionFilter service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorOperationAborted
,AWSLogsErrorServiceUnavailable
. -
Deletes the specified subscription filter.
See
AWSLogsDeleteSubscriptionFilterRequest
Declaration
Objective-C
- (void)deleteSubscriptionFilter: (nonnull AWSLogsDeleteSubscriptionFilterRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func deleteSubscriptionFilter(_ request: AWSLogsDeleteSubscriptionFilterRequest) async throws
Parameters
request
A container for the necessary parameters to execute the DeleteSubscriptionFilter service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorOperationAborted
,AWSLogsErrorServiceUnavailable
. -
Returns a list of all CloudWatch Logs account policies in the account.
See
AWSLogsDescribeAccountPoliciesRequest
See
AWSLogsDescribeAccountPoliciesResponse
Declaration
Objective-C
- (id)describeAccountPolicies: (nonnull AWSLogsDescribeAccountPoliciesRequest *)request;
Swift
func describeAccountPolicies(_ request: AWSLogsDescribeAccountPoliciesRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribeAccountPolicies service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsDescribeAccountPoliciesResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorOperationAborted
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
Returns a list of all CloudWatch Logs account policies in the account.
See
AWSLogsDescribeAccountPoliciesRequest
See
AWSLogsDescribeAccountPoliciesResponse
Declaration
Objective-C
- (void)describeAccountPolicies: (nonnull AWSLogsDescribeAccountPoliciesRequest *)request completionHandler: (void (^_Nullable)( AWSLogsDescribeAccountPoliciesResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describeAccountPolicies(_ request: AWSLogsDescribeAccountPoliciesRequest) async throws -> AWSLogsDescribeAccountPoliciesResponse
Parameters
request
A container for the necessary parameters to execute the DescribeAccountPolicies service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorOperationAborted
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
Retrieves a list of the deliveries that have been created in the account.
A delivery is a connection between a delivery source and a delivery destination.
A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose. Only some Amazon Web Services services support being configured as a delivery source. These services are listed in Enable logging from Amazon Web Services services.
See
AWSLogsDescribeDeliveriesRequest
See
AWSLogsDescribeDeliveriesResponse
Declaration
Objective-C
- (id)describeDeliveries:(nonnull AWSLogsDescribeDeliveriesRequest *)request;
Swift
func describeDeliveries(_ request: AWSLogsDescribeDeliveriesRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribeDeliveries service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsDescribeDeliveriesResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorServiceUnavailable
,AWSLogsErrorServiceQuotaExceeded
,AWSLogsErrorValidation
,AWSLogsErrorThrottling
. -
Retrieves a list of the deliveries that have been created in the account.
A delivery is a connection between a delivery source and a delivery destination.
A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose. Only some Amazon Web Services services support being configured as a delivery source. These services are listed in Enable logging from Amazon Web Services services.
See
AWSLogsDescribeDeliveriesRequest
See
AWSLogsDescribeDeliveriesResponse
Declaration
Objective-C
- (void)describeDeliveries:(nonnull AWSLogsDescribeDeliveriesRequest *)request completionHandler: (void (^_Nullable)(AWSLogsDescribeDeliveriesResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describeDeliveries(_ request: AWSLogsDescribeDeliveriesRequest) async throws -> AWSLogsDescribeDeliveriesResponse
Parameters
request
A container for the necessary parameters to execute the DescribeDeliveries service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorServiceUnavailable
,AWSLogsErrorServiceQuotaExceeded
,AWSLogsErrorValidation
,AWSLogsErrorThrottling
. -
Retrieves a list of the delivery destinations that have been created in the account.
See
AWSLogsDescribeDeliveryDestinationsRequest
See
AWSLogsDescribeDeliveryDestinationsResponse
Declaration
Objective-C
- (id)describeDeliveryDestinations: (nonnull AWSLogsDescribeDeliveryDestinationsRequest *)request;
Swift
func describeDeliveryDestinations(_ request: AWSLogsDescribeDeliveryDestinationsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribeDeliveryDestinations service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsDescribeDeliveryDestinationsResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorServiceUnavailable
,AWSLogsErrorServiceQuotaExceeded
,AWSLogsErrorValidation
,AWSLogsErrorThrottling
. -
Retrieves a list of the delivery destinations that have been created in the account.
See
AWSLogsDescribeDeliveryDestinationsRequest
See
AWSLogsDescribeDeliveryDestinationsResponse
Declaration
Objective-C
- (void) describeDeliveryDestinations: (nonnull AWSLogsDescribeDeliveryDestinationsRequest *)request completionHandler: (void (^_Nullable)( AWSLogsDescribeDeliveryDestinationsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describeDeliveryDestinations(_ request: AWSLogsDescribeDeliveryDestinationsRequest) async throws -> AWSLogsDescribeDeliveryDestinationsResponse
Parameters
request
A container for the necessary parameters to execute the DescribeDeliveryDestinations service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorServiceUnavailable
,AWSLogsErrorServiceQuotaExceeded
,AWSLogsErrorValidation
,AWSLogsErrorThrottling
. -
Retrieves a list of the delivery sources that have been created in the account.
See
AWSLogsDescribeDeliverySourcesRequest
See
AWSLogsDescribeDeliverySourcesResponse
Declaration
Objective-C
- (id)describeDeliverySources: (nonnull AWSLogsDescribeDeliverySourcesRequest *)request;
Swift
func describeDeliverySources(_ request: AWSLogsDescribeDeliverySourcesRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribeDeliverySources service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsDescribeDeliverySourcesResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorServiceUnavailable
,AWSLogsErrorServiceQuotaExceeded
,AWSLogsErrorValidation
,AWSLogsErrorThrottling
. -
Retrieves a list of the delivery sources that have been created in the account.
See
AWSLogsDescribeDeliverySourcesRequest
See
AWSLogsDescribeDeliverySourcesResponse
Declaration
Objective-C
- (void)describeDeliverySources: (nonnull AWSLogsDescribeDeliverySourcesRequest *)request completionHandler: (void (^_Nullable)( AWSLogsDescribeDeliverySourcesResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describeDeliverySources(_ request: AWSLogsDescribeDeliverySourcesRequest) async throws -> AWSLogsDescribeDeliverySourcesResponse
Parameters
request
A container for the necessary parameters to execute the DescribeDeliverySources service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorServiceUnavailable
,AWSLogsErrorServiceQuotaExceeded
,AWSLogsErrorValidation
,AWSLogsErrorThrottling
. -
Lists all your destinations. The results are ASCII-sorted by destination name.
See
AWSLogsDescribeDestinationsRequest
See
AWSLogsDescribeDestinationsResponse
Declaration
Objective-C
- (id)describeDestinations: (nonnull AWSLogsDescribeDestinationsRequest *)request;
Swift
func describeDestinations(_ request: AWSLogsDescribeDestinationsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribeDestinations service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsDescribeDestinationsResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorServiceUnavailable
. -
Lists all your destinations. The results are ASCII-sorted by destination name.
See
AWSLogsDescribeDestinationsRequest
See
AWSLogsDescribeDestinationsResponse
Declaration
Objective-C
- (void) describeDestinations:(nonnull AWSLogsDescribeDestinationsRequest *)request completionHandler: (void (^_Nullable)(AWSLogsDescribeDestinationsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describeDestinations(_ request: AWSLogsDescribeDestinationsRequest) async throws -> AWSLogsDescribeDestinationsResponse
Parameters
request
A container for the necessary parameters to execute the DescribeDestinations service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorServiceUnavailable
. -
Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.
See
AWSLogsDescribeExportTasksRequest
See
AWSLogsDescribeExportTasksResponse
Declaration
Objective-C
- (id)describeExportTasks:(nonnull AWSLogsDescribeExportTasksRequest *)request;
Swift
func describeExportTasks(_ request: AWSLogsDescribeExportTasksRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribeExportTasks service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsDescribeExportTasksResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorServiceUnavailable
. -
Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.
See
AWSLogsDescribeExportTasksRequest
See
AWSLogsDescribeExportTasksResponse
Declaration
Objective-C
- (void)describeExportTasks:(nonnull AWSLogsDescribeExportTasksRequest *)request completionHandler: (void (^_Nullable)(AWSLogsDescribeExportTasksResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describeExportTasks(_ request: AWSLogsDescribeExportTasksRequest) async throws -> AWSLogsDescribeExportTasksResponse
Parameters
request
A container for the necessary parameters to execute the DescribeExportTasks service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorServiceUnavailable
. -
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.
CloudWatch Logs doesn’t support IAM policies that control access to the
DescribeLogGroups
action by using theaws:ResourceTag/key-name
condition key. Other CloudWatch Logs actions do support the use of theaws:ResourceTag/key-name
condition key to control access. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
See
AWSLogsDescribeLogGroupsRequest
See
AWSLogsDescribeLogGroupsResponse
Declaration
Objective-C
- (id)describeLogGroups:(nonnull AWSLogsDescribeLogGroupsRequest *)request;
Swift
func describeLogGroups(_ request: AWSLogsDescribeLogGroupsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribeLogGroups service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsDescribeLogGroupsResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorServiceUnavailable
. -
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.
CloudWatch Logs doesn’t support IAM policies that control access to the
DescribeLogGroups
action by using theaws:ResourceTag/key-name
condition key. Other CloudWatch Logs actions do support the use of theaws:ResourceTag/key-name
condition key to control access. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
See
AWSLogsDescribeLogGroupsRequest
See
AWSLogsDescribeLogGroupsResponse
Declaration
Objective-C
- (void)describeLogGroups:(nonnull AWSLogsDescribeLogGroupsRequest *)request completionHandler: (void (^_Nullable)(AWSLogsDescribeLogGroupsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describeLogGroups(_ request: AWSLogsDescribeLogGroupsRequest) async throws -> AWSLogsDescribeLogGroupsResponse
Parameters
request
A container for the necessary parameters to execute the DescribeLogGroups service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorServiceUnavailable
. -
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.
You can specify the log group to search by using either
logGroupIdentifier
orlogGroupName
. You must include one of these two parameters, but you can’t include both.This operation has a limit of five transactions per second, after which transactions are throttled.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
See
AWSLogsDescribeLogStreamsRequest
See
AWSLogsDescribeLogStreamsResponse
Declaration
Objective-C
- (id)describeLogStreams:(nonnull AWSLogsDescribeLogStreamsRequest *)request;
Swift
func describeLogStreams(_ request: AWSLogsDescribeLogStreamsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribeLogStreams service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsDescribeLogStreamsResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
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.
You can specify the log group to search by using either
logGroupIdentifier
orlogGroupName
. You must include one of these two parameters, but you can’t include both.This operation has a limit of five transactions per second, after which transactions are throttled.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
See
AWSLogsDescribeLogStreamsRequest
See
AWSLogsDescribeLogStreamsResponse
Declaration
Objective-C
- (void)describeLogStreams:(nonnull AWSLogsDescribeLogStreamsRequest *)request completionHandler: (void (^_Nullable)(AWSLogsDescribeLogStreamsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describeLogStreams(_ request: AWSLogsDescribeLogStreamsRequest) async throws -> AWSLogsDescribeLogStreamsResponse
Parameters
request
A container for the necessary parameters to execute the DescribeLogStreams service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
Lists the specified metric filters. You can list all of the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.
See
AWSLogsDescribeMetricFiltersRequest
See
AWSLogsDescribeMetricFiltersResponse
Declaration
Objective-C
- (id)describeMetricFilters: (nonnull AWSLogsDescribeMetricFiltersRequest *)request;
Swift
func describeMetricFilters(_ request: AWSLogsDescribeMetricFiltersRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribeMetricFilters service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsDescribeMetricFiltersResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
Lists the specified metric filters. You can list all of the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.
See
AWSLogsDescribeMetricFiltersRequest
See
AWSLogsDescribeMetricFiltersResponse
Declaration
Objective-C
- (void) describeMetricFilters:(nonnull AWSLogsDescribeMetricFiltersRequest *)request completionHandler: (void (^_Nullable)(AWSLogsDescribeMetricFiltersResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describeMetricFilters(_ request: AWSLogsDescribeMetricFiltersRequest) async throws -> AWSLogsDescribeMetricFiltersResponse
Parameters
request
A container for the necessary parameters to execute the DescribeMetricFilters service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
Returns a list of CloudWatch Logs Insights queries that are scheduled, running, or have been run recently in this account. You can request all queries or limit it to queries of a specific log group or queries with a certain status.
See
AWSLogsDescribeQueriesRequest
See
AWSLogsDescribeQueriesResponse
Declaration
Objective-C
- (id)describeQueries:(nonnull AWSLogsDescribeQueriesRequest *)request;
Swift
func describeQueries(_ request: AWSLogsDescribeQueriesRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribeQueries service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsDescribeQueriesResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
Returns a list of CloudWatch Logs Insights queries that are scheduled, running, or have been run recently in this account. You can request all queries or limit it to queries of a specific log group or queries with a certain status.
See
AWSLogsDescribeQueriesRequest
See
AWSLogsDescribeQueriesResponse
Declaration
Objective-C
- (void)describeQueries:(nonnull AWSLogsDescribeQueriesRequest *)request completionHandler: (void (^_Nullable)(AWSLogsDescribeQueriesResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describeQueries(_ request: AWSLogsDescribeQueriesRequest) async throws -> AWSLogsDescribeQueriesResponse
Parameters
request
A container for the necessary parameters to execute the DescribeQueries service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions. You can retrieve query definitions from the current account or from a source account that is linked to the current account.
You can use the
queryDefinitionNamePrefix
parameter to limit the results to only the query definitions that have names that start with a certain string.See
AWSLogsDescribeQueryDefinitionsRequest
See
AWSLogsDescribeQueryDefinitionsResponse
Declaration
Objective-C
- (id)describeQueryDefinitions: (nonnull AWSLogsDescribeQueryDefinitionsRequest *)request;
Swift
func describeQueryDefinitions(_ request: AWSLogsDescribeQueryDefinitionsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribeQueryDefinitions service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsDescribeQueryDefinitionsResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorServiceUnavailable
. -
This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions. You can retrieve query definitions from the current account or from a source account that is linked to the current account.
You can use the
queryDefinitionNamePrefix
parameter to limit the results to only the query definitions that have names that start with a certain string.See
AWSLogsDescribeQueryDefinitionsRequest
See
AWSLogsDescribeQueryDefinitionsResponse
Declaration
Objective-C
- (void)describeQueryDefinitions: (nonnull AWSLogsDescribeQueryDefinitionsRequest *)request completionHandler: (void (^_Nullable)( AWSLogsDescribeQueryDefinitionsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describeQueryDefinitions(_ request: AWSLogsDescribeQueryDefinitionsRequest) async throws -> AWSLogsDescribeQueryDefinitionsResponse
Parameters
request
A container for the necessary parameters to execute the DescribeQueryDefinitions service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorServiceUnavailable
. -
Lists the resource policies in this account.
See
AWSLogsDescribeResourcePoliciesRequest
See
AWSLogsDescribeResourcePoliciesResponse
Declaration
Objective-C
- (id)describeResourcePolicies: (nonnull AWSLogsDescribeResourcePoliciesRequest *)request;
Swift
func describeResourcePolicies(_ request: AWSLogsDescribeResourcePoliciesRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribeResourcePolicies service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsDescribeResourcePoliciesResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorServiceUnavailable
. -
Lists the resource policies in this account.
See
AWSLogsDescribeResourcePoliciesRequest
See
AWSLogsDescribeResourcePoliciesResponse
Declaration
Objective-C
- (void)describeResourcePolicies: (nonnull AWSLogsDescribeResourcePoliciesRequest *)request completionHandler: (void (^_Nullable)( AWSLogsDescribeResourcePoliciesResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describeResourcePolicies(_ request: AWSLogsDescribeResourcePoliciesRequest) async throws -> AWSLogsDescribeResourcePoliciesResponse
Parameters
request
A container for the necessary parameters to execute the DescribeResourcePolicies service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorServiceUnavailable
. -
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.
See
AWSLogsDescribeSubscriptionFiltersRequest
See
AWSLogsDescribeSubscriptionFiltersResponse
Declaration
Objective-C
- (id)describeSubscriptionFilters: (nonnull AWSLogsDescribeSubscriptionFiltersRequest *)request;
Swift
func describeSubscriptionFilters(_ request: AWSLogsDescribeSubscriptionFiltersRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribeSubscriptionFilters service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsDescribeSubscriptionFiltersResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
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.
See
AWSLogsDescribeSubscriptionFiltersRequest
See
AWSLogsDescribeSubscriptionFiltersResponse
Declaration
Objective-C
- (void)describeSubscriptionFilters: (nonnull AWSLogsDescribeSubscriptionFiltersRequest *)request completionHandler: (void (^_Nullable)( AWSLogsDescribeSubscriptionFiltersResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describeSubscriptionFilters(_ request: AWSLogsDescribeSubscriptionFiltersRequest) async throws -> AWSLogsDescribeSubscriptionFiltersResponse
Parameters
request
A container for the necessary parameters to execute the DescribeSubscriptionFilters service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
Disassociates the specified KMS key from the specified log group or from all CloudWatch Logs Insights query results in the account.
When you use
DisassociateKmsKey
, you specify either thelogGroupName
parameter or theresourceIdentifier
parameter. You can’t specify both of those parameters in the same operation.Specify the
logGroupName
parameter to stop using the KMS key to encrypt future log events ingested and stored in the log group. Instead, they will be encrypted with the default CloudWatch Logs method. The log events that were ingested while the key was associated with the log group are still encrypted with that key. Therefore, CloudWatch Logs will need permissions for the key whenever that data is accessed.Specify the
resourceIdentifier
parameter with thequery-result
resource to stop using the KMS key to encrypt the results of all future StartQuery operations in the account. They will instead be encrypted with the default CloudWatch Logs method. The results from queries that ran while the key was associated with the account are still encrypted with that key. Therefore, CloudWatch Logs will need permissions for the key whenever that data is accessed.
It can take up to 5 minutes for this operation to take effect.
See
AWSLogsDisassociateKmsKeyRequest
Declaration
Objective-C
- (id)disassociateKmsKey:(nonnull AWSLogsDisassociateKmsKeyRequest *)request;
Swift
func disassociateKmsKey(_ request: AWSLogsDisassociateKmsKeyRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DisassociateKmsKey service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorOperationAborted
,AWSLogsErrorServiceUnavailable
. -
Disassociates the specified KMS key from the specified log group or from all CloudWatch Logs Insights query results in the account.
When you use
DisassociateKmsKey
, you specify either thelogGroupName
parameter or theresourceIdentifier
parameter. You can’t specify both of those parameters in the same operation.Specify the
logGroupName
parameter to stop using the KMS key to encrypt future log events ingested and stored in the log group. Instead, they will be encrypted with the default CloudWatch Logs method. The log events that were ingested while the key was associated with the log group are still encrypted with that key. Therefore, CloudWatch Logs will need permissions for the key whenever that data is accessed.Specify the
resourceIdentifier
parameter with thequery-result
resource to stop using the KMS key to encrypt the results of all future StartQuery operations in the account. They will instead be encrypted with the default CloudWatch Logs method. The results from queries that ran while the key was associated with the account are still encrypted with that key. Therefore, CloudWatch Logs will need permissions for the key whenever that data is accessed.
It can take up to 5 minutes for this operation to take effect.
See
AWSLogsDisassociateKmsKeyRequest
Declaration
Objective-C
- (void)disassociateKmsKey:(nonnull AWSLogsDisassociateKmsKeyRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func disassociateKmsKey(_ request: AWSLogsDisassociateKmsKeyRequest) async throws
Parameters
request
A container for the necessary parameters to execute the DisassociateKmsKey service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorOperationAborted
,AWSLogsErrorServiceUnavailable
. -
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.
You must have the
logs:FilterLogEvents
permission to perform this operation.You can specify the log group to search by using either
logGroupIdentifier
orlogGroupName
. You must include one of these two parameters, but you can’t include both.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 specified time range. If the results include a token, that means there are more log events available. You can get additional results by specifying the token in a subsequent call. This operation can return empty results while there are more log events available through the token.
The returned log events are sorted by event timestamp, the timestamp when the event was ingested by CloudWatch Logs, and the ID of the
PutLogEvents
request.If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
See
AWSLogsFilterLogEventsRequest
See
AWSLogsFilterLogEventsResponse
Declaration
Objective-C
- (id)filterLogEvents:(nonnull AWSLogsFilterLogEventsRequest *)request;
Swift
func filterLogEvents(_ request: AWSLogsFilterLogEventsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the FilterLogEvents service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsFilterLogEventsResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
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.
You must have the
logs:FilterLogEvents
permission to perform this operation.You can specify the log group to search by using either
logGroupIdentifier
orlogGroupName
. You must include one of these two parameters, but you can’t include both.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 specified time range. If the results include a token, that means there are more log events available. You can get additional results by specifying the token in a subsequent call. This operation can return empty results while there are more log events available through the token.
The returned log events are sorted by event timestamp, the timestamp when the event was ingested by CloudWatch Logs, and the ID of the
PutLogEvents
request.If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
See
AWSLogsFilterLogEventsRequest
See
AWSLogsFilterLogEventsResponse
Declaration
Objective-C
- (void)filterLogEvents:(nonnull AWSLogsFilterLogEventsRequest *)request completionHandler: (void (^_Nullable)(AWSLogsFilterLogEventsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func filterLogEvents(_ request: AWSLogsFilterLogEventsRequest) async throws -> AWSLogsFilterLogEventsResponse
Parameters
request
A container for the necessary parameters to execute the FilterLogEvents service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
Returns information about a log group data protection policy.
See
AWSLogsGetDataProtectionPolicyRequest
See
AWSLogsGetDataProtectionPolicyResponse
Declaration
Objective-C
- (id)getDataProtectionPolicy: (nonnull AWSLogsGetDataProtectionPolicyRequest *)request;
Swift
func getDataProtectionPolicy(_ request: AWSLogsGetDataProtectionPolicyRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetDataProtectionPolicy service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsGetDataProtectionPolicyResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorOperationAborted
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
Returns information about a log group data protection policy.
See
AWSLogsGetDataProtectionPolicyRequest
See
AWSLogsGetDataProtectionPolicyResponse
Declaration
Objective-C
- (void)getDataProtectionPolicy: (nonnull AWSLogsGetDataProtectionPolicyRequest *)request completionHandler: (void (^_Nullable)( AWSLogsGetDataProtectionPolicyResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func dataProtectionPolicy(_ request: AWSLogsGetDataProtectionPolicyRequest) async throws -> AWSLogsGetDataProtectionPolicyResponse
Parameters
request
A container for the necessary parameters to execute the GetDataProtectionPolicy service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorOperationAborted
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
Returns complete information about one logical delivery. A delivery is a connection between a delivery source and a delivery destination.
A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose. Only some Amazon Web Services services support being configured as a delivery source. These services are listed in Enable logging from Amazon Web Services services.
You need to specify the delivery
id
in this operation. You can find the IDs of the deliveries in your account with the DescribeDeliveries operation.See
AWSLogsGetDeliveryRequest
See
AWSLogsGetDeliveryResponse
Declaration
Objective-C
- (id)getDelivery:(nonnull AWSLogsGetDeliveryRequest *)request;
Swift
func getDelivery(_ request: AWSLogsGetDeliveryRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetDelivery service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsGetDeliveryResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
,AWSLogsErrorValidation
,AWSLogsErrorServiceQuotaExceeded
,AWSLogsErrorThrottling
. -
Returns complete information about one logical delivery. A delivery is a connection between a delivery source and a delivery destination.
A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose. Only some Amazon Web Services services support being configured as a delivery source. These services are listed in Enable logging from Amazon Web Services services.
You need to specify the delivery
id
in this operation. You can find the IDs of the deliveries in your account with the DescribeDeliveries operation.See
AWSLogsGetDeliveryRequest
See
AWSLogsGetDeliveryResponse
Declaration
Objective-C
- (void)getDelivery:(nonnull AWSLogsGetDeliveryRequest *)request completionHandler:(void (^_Nullable)(AWSLogsGetDeliveryResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func delivery(_ request: AWSLogsGetDeliveryRequest) async throws -> AWSLogsGetDeliveryResponse
Parameters
request
A container for the necessary parameters to execute the GetDelivery service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
,AWSLogsErrorValidation
,AWSLogsErrorServiceQuotaExceeded
,AWSLogsErrorThrottling
. -
Retrieves complete information about one delivery destination.
See
AWSLogsGetDeliveryDestinationRequest
See
AWSLogsGetDeliveryDestinationResponse
Declaration
Objective-C
- (id)getDeliveryDestination: (nonnull AWSLogsGetDeliveryDestinationRequest *)request;
Swift
func getDeliveryDestination(_ request: AWSLogsGetDeliveryDestinationRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetDeliveryDestination service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsGetDeliveryDestinationResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
,AWSLogsErrorValidation
,AWSLogsErrorServiceQuotaExceeded
,AWSLogsErrorThrottling
. -
Retrieves complete information about one delivery destination.
See
AWSLogsGetDeliveryDestinationRequest
See
AWSLogsGetDeliveryDestinationResponse
Declaration
Objective-C
- (void)getDeliveryDestination: (nonnull AWSLogsGetDeliveryDestinationRequest *)request completionHandler: (void (^_Nullable)( AWSLogsGetDeliveryDestinationResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func deliveryDestination(_ request: AWSLogsGetDeliveryDestinationRequest) async throws -> AWSLogsGetDeliveryDestinationResponse
Parameters
request
A container for the necessary parameters to execute the GetDeliveryDestination service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
,AWSLogsErrorValidation
,AWSLogsErrorServiceQuotaExceeded
,AWSLogsErrorThrottling
. -
Retrieves the delivery destination policy assigned to the delivery destination that you specify. For more information about delivery destinations and their policies, see PutDeliveryDestinationPolicy.
See
AWSLogsGetDeliveryDestinationPolicyRequest
See
AWSLogsGetDeliveryDestinationPolicyResponse
Declaration
Objective-C
- (id)getDeliveryDestinationPolicy: (nonnull AWSLogsGetDeliveryDestinationPolicyRequest *)request;
Swift
func getDeliveryDestinationPolicy(_ request: AWSLogsGetDeliveryDestinationPolicyRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetDeliveryDestinationPolicy service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsGetDeliveryDestinationPolicyResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorServiceUnavailable
,AWSLogsErrorValidation
,AWSLogsErrorResourceNotFound
. -
Retrieves the delivery destination policy assigned to the delivery destination that you specify. For more information about delivery destinations and their policies, see PutDeliveryDestinationPolicy.
See
AWSLogsGetDeliveryDestinationPolicyRequest
See
AWSLogsGetDeliveryDestinationPolicyResponse
Declaration
Objective-C
- (void) getDeliveryDestinationPolicy: (nonnull AWSLogsGetDeliveryDestinationPolicyRequest *)request completionHandler: (void (^_Nullable)( AWSLogsGetDeliveryDestinationPolicyResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func deliveryDestinationPolicy(_ request: AWSLogsGetDeliveryDestinationPolicyRequest) async throws -> AWSLogsGetDeliveryDestinationPolicyResponse
Parameters
request
A container for the necessary parameters to execute the GetDeliveryDestinationPolicy service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorServiceUnavailable
,AWSLogsErrorValidation
,AWSLogsErrorResourceNotFound
. -
Retrieves complete information about one delivery source.
See
AWSLogsGetDeliverySourceRequest
See
AWSLogsGetDeliverySourceResponse
Declaration
Objective-C
- (id)getDeliverySource:(nonnull AWSLogsGetDeliverySourceRequest *)request;
Swift
func getDeliverySource(_ request: AWSLogsGetDeliverySourceRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetDeliverySource service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsGetDeliverySourceResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
,AWSLogsErrorValidation
,AWSLogsErrorServiceQuotaExceeded
,AWSLogsErrorThrottling
. -
Retrieves complete information about one delivery source.
See
AWSLogsGetDeliverySourceRequest
See
AWSLogsGetDeliverySourceResponse
Declaration
Objective-C
- (void)getDeliverySource:(nonnull AWSLogsGetDeliverySourceRequest *)request completionHandler: (void (^_Nullable)(AWSLogsGetDeliverySourceResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func deliverySource(_ request: AWSLogsGetDeliverySourceRequest) async throws -> AWSLogsGetDeliverySourceResponse
Parameters
request
A container for the necessary parameters to execute the GetDeliverySource service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
,AWSLogsErrorValidation
,AWSLogsErrorServiceQuotaExceeded
,AWSLogsErrorThrottling
. -
Retrieves information about the log anomaly detector that you specify.
See
AWSLogsGetLogAnomalyDetectorRequest
See
AWSLogsGetLogAnomalyDetectorResponse
Declaration
Objective-C
- (id)getLogAnomalyDetector: (nonnull AWSLogsGetLogAnomalyDetectorRequest *)request;
Swift
func getLogAnomalyDetector(_ request: AWSLogsGetLogAnomalyDetectorRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetLogAnomalyDetector service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsGetLogAnomalyDetectorResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
,AWSLogsErrorOperationAborted
. -
Retrieves information about the log anomaly detector that you specify.
See
AWSLogsGetLogAnomalyDetectorRequest
See
AWSLogsGetLogAnomalyDetectorResponse
Declaration
Objective-C
- (void) getLogAnomalyDetector:(nonnull AWSLogsGetLogAnomalyDetectorRequest *)request completionHandler: (void (^_Nullable)(AWSLogsGetLogAnomalyDetectorResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func logAnomalyDetector(_ request: AWSLogsGetLogAnomalyDetectorRequest) async throws -> AWSLogsGetLogAnomalyDetectorResponse
Parameters
request
A container for the necessary parameters to execute the GetLogAnomalyDetector service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
,AWSLogsErrorOperationAborted
. -
Lists log events from the specified log stream. You can list all of 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. This operation can return empty results while there are more log events available through the token.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
You can specify the log group to search by using either
logGroupIdentifier
orlogGroupName
. You must include one of these two parameters, but you can’t include both.See
AWSLogsGetLogEventsRequest
See
AWSLogsGetLogEventsResponse
Declaration
Objective-C
- (id)getLogEvents:(nonnull AWSLogsGetLogEventsRequest *)request;
Swift
func getLogEvents(_ request: AWSLogsGetLogEventsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetLogEvents service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsGetLogEventsResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
Lists log events from the specified log stream. You can list all of 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. This operation can return empty results while there are more log events available through the token.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
You can specify the log group to search by using either
logGroupIdentifier
orlogGroupName
. You must include one of these two parameters, but you can’t include both.See
AWSLogsGetLogEventsRequest
See
AWSLogsGetLogEventsResponse
Declaration
Objective-C
- (void)getLogEvents:(nonnull AWSLogsGetLogEventsRequest *)request completionHandler:(void (^_Nullable)(AWSLogsGetLogEventsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func logEvents(_ request: AWSLogsGetLogEventsRequest) async throws -> AWSLogsGetLogEventsResponse
Parameters
request
A container for the necessary parameters to execute the GetLogEvents service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
Returns a list of the fields that are included in log events in the specified log group. Includes the percentage of log events that contain each field. The search is limited to a time period that you specify.
You can specify the log group to search by using either
logGroupIdentifier
orlogGroupName
. You must specify one of these parameters, but you can’t specify both.In the results, fields that start with
@
are fields generated by CloudWatch Logs. For example,@timestamp
is the timestamp of each log event. For more information about the fields that are generated by CloudWatch logs, see Supported Logs and Discovered Fields.The response results are sorted by the frequency percentage, starting with the highest percentage.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
See
AWSLogsGetLogGroupFieldsRequest
See
AWSLogsGetLogGroupFieldsResponse
Declaration
Objective-C
- (id)getLogGroupFields:(nonnull AWSLogsGetLogGroupFieldsRequest *)request;
Swift
func getLogGroupFields(_ request: AWSLogsGetLogGroupFieldsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetLogGroupFields service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsGetLogGroupFieldsResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorLimitExceeded
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
Returns a list of the fields that are included in log events in the specified log group. Includes the percentage of log events that contain each field. The search is limited to a time period that you specify.
You can specify the log group to search by using either
logGroupIdentifier
orlogGroupName
. You must specify one of these parameters, but you can’t specify both.In the results, fields that start with
@
are fields generated by CloudWatch Logs. For example,@timestamp
is the timestamp of each log event. For more information about the fields that are generated by CloudWatch logs, see Supported Logs and Discovered Fields.The response results are sorted by the frequency percentage, starting with the highest percentage.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
See
AWSLogsGetLogGroupFieldsRequest
See
AWSLogsGetLogGroupFieldsResponse
Declaration
Objective-C
- (void)getLogGroupFields:(nonnull AWSLogsGetLogGroupFieldsRequest *)request completionHandler: (void (^_Nullable)(AWSLogsGetLogGroupFieldsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func logGroupFields(_ request: AWSLogsGetLogGroupFieldsRequest) async throws -> AWSLogsGetLogGroupFieldsResponse
Parameters
request
A container for the necessary parameters to execute the GetLogGroupFields service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorLimitExceeded
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
Retrieves all of the fields and values of a single log event. All fields are retrieved, even if the original query that produced the
logRecordPointer
retrieved only a subset of fields. Fields are returned as field name/field value pairs.The full unparsed log event is returned within
@message
.See
AWSLogsGetLogRecordRequest
See
AWSLogsGetLogRecordResponse
Declaration
Objective-C
- (id)getLogRecord:(nonnull AWSLogsGetLogRecordRequest *)request;
Swift
func getLogRecord(_ request: AWSLogsGetLogRecordRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetLogRecord service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsGetLogRecordResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorLimitExceeded
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
Retrieves all of the fields and values of a single log event. All fields are retrieved, even if the original query that produced the
logRecordPointer
retrieved only a subset of fields. Fields are returned as field name/field value pairs.The full unparsed log event is returned within
@message
.See
AWSLogsGetLogRecordRequest
See
AWSLogsGetLogRecordResponse
Declaration
Objective-C
- (void)getLogRecord:(nonnull AWSLogsGetLogRecordRequest *)request completionHandler:(void (^_Nullable)(AWSLogsGetLogRecordResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func logRecord(_ request: AWSLogsGetLogRecordRequest) async throws -> AWSLogsGetLogRecordResponse
Parameters
request
A container for the necessary parameters to execute the GetLogRecord service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorLimitExceeded
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
Returns the results from the specified query.
Only the fields requested in the query are returned, along with a
@ptr
field, which is the identifier for the log record. You can use the value of@ptr
in a GetLogRecord operation to get the full log record.GetQueryResults
does not start running a query. To run a query, use StartQuery. For more information about how long results of previous queries are available, see CloudWatch Logs quotas.If the value of the
Status
field in the output isRunning
, this operation returns only partial results. If you see a value ofScheduled
orRunning
for the status, you can retry the operation later to see the final results.If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start queries in linked source accounts. For more information, see CloudWatch cross-account observability.
See
AWSLogsGetQueryResultsRequest
See
AWSLogsGetQueryResultsResponse
Declaration
Objective-C
- (id)getQueryResults:(nonnull AWSLogsGetQueryResultsRequest *)request;
Swift
func getQueryResults(_ request: AWSLogsGetQueryResultsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetQueryResults service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsGetQueryResultsResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
Returns the results from the specified query.
Only the fields requested in the query are returned, along with a
@ptr
field, which is the identifier for the log record. You can use the value of@ptr
in a GetLogRecord operation to get the full log record.GetQueryResults
does not start running a query. To run a query, use StartQuery. For more information about how long results of previous queries are available, see CloudWatch Logs quotas.If the value of the
Status
field in the output isRunning
, this operation returns only partial results. If you see a value ofScheduled
orRunning
for the status, you can retry the operation later to see the final results.If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start queries in linked source accounts. For more information, see CloudWatch cross-account observability.
See
AWSLogsGetQueryResultsRequest
See
AWSLogsGetQueryResultsResponse
Declaration
Objective-C
- (void)getQueryResults:(nonnull AWSLogsGetQueryResultsRequest *)request completionHandler: (void (^_Nullable)(AWSLogsGetQueryResultsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func queryResults(_ request: AWSLogsGetQueryResultsRequest) async throws -> AWSLogsGetQueryResultsResponse
Parameters
request
A container for the necessary parameters to execute the GetQueryResults service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
Returns a list of anomalies that log anomaly detectors have found. For details about the structure format of each anomaly object that is returned, see the example in this section.
See
AWSLogsListAnomaliesRequest
See
AWSLogsListAnomaliesResponse
Declaration
Objective-C
- (id)listAnomalies:(nonnull AWSLogsListAnomaliesRequest *)request;
Swift
func listAnomalies(_ request: AWSLogsListAnomaliesRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the ListAnomalies service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsListAnomaliesResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
,AWSLogsErrorOperationAborted
. -
Returns a list of anomalies that log anomaly detectors have found. For details about the structure format of each anomaly object that is returned, see the example in this section.
See
AWSLogsListAnomaliesRequest
See
AWSLogsListAnomaliesResponse
Declaration
Objective-C
- (void)listAnomalies:(nonnull AWSLogsListAnomaliesRequest *)request completionHandler: (void (^_Nullable)(AWSLogsListAnomaliesResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func listAnomalies(_ request: AWSLogsListAnomaliesRequest) async throws -> AWSLogsListAnomaliesResponse
Parameters
request
A container for the necessary parameters to execute the ListAnomalies service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
,AWSLogsErrorOperationAborted
. -
Retrieves a list of the log anomaly detectors in the account.
See
AWSLogsListLogAnomalyDetectorsRequest
See
AWSLogsListLogAnomalyDetectorsResponse
Declaration
Objective-C
- (id)listLogAnomalyDetectors: (nonnull AWSLogsListLogAnomalyDetectorsRequest *)request;
Swift
func listLogAnomalyDetectors(_ request: AWSLogsListLogAnomalyDetectorsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the ListLogAnomalyDetectors service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsListLogAnomalyDetectorsResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
,AWSLogsErrorOperationAborted
. -
Retrieves a list of the log anomaly detectors in the account.
See
AWSLogsListLogAnomalyDetectorsRequest
See
AWSLogsListLogAnomalyDetectorsResponse
Declaration
Objective-C
- (void)listLogAnomalyDetectors: (nonnull AWSLogsListLogAnomalyDetectorsRequest *)request completionHandler: (void (^_Nullable)( AWSLogsListLogAnomalyDetectorsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func listLogAnomalyDetectors(_ request: AWSLogsListLogAnomalyDetectorsRequest) async throws -> AWSLogsListLogAnomalyDetectorsResponse
Parameters
request
A container for the necessary parameters to execute the ListLogAnomalyDetectors service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
,AWSLogsErrorOperationAborted
. -
Displays the tags associated with a CloudWatch Logs resource. Currently, log groups and destinations support tagging.
See
AWSLogsListTagsForResourceRequest
See
AWSLogsListTagsForResourceResponse
Declaration
Objective-C
- (id)listTagsForResource:(nonnull AWSLogsListTagsForResourceRequest *)request;
Swift
func listTags(forResource request: AWSLogsListTagsForResourceRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the ListTagsForResource service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsListTagsForResourceResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
Displays the tags associated with a CloudWatch Logs resource. Currently, log groups and destinations support tagging.
See
AWSLogsListTagsForResourceRequest
See
AWSLogsListTagsForResourceResponse
Declaration
Objective-C
- (void)listTagsForResource:(nonnull AWSLogsListTagsForResourceRequest *)request completionHandler: (void (^_Nullable)(AWSLogsListTagsForResourceResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func listTags(forResource request: AWSLogsListTagsForResourceRequest) async throws -> AWSLogsListTagsForResourceResponse
Parameters
request
A container for the necessary parameters to execute the ListTagsForResource service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
The ListTagsLogGroup operation is on the path to deprecation. We recommend that you use ListTagsForResource instead.
Lists the tags for the specified log group.
See
AWSLogsListTagsLogGroupRequest
See
AWSLogsListTagsLogGroupResponse
Declaration
Objective-C
- (id)listTagsLogGroup:(nonnull AWSLogsListTagsLogGroupRequest *)request;
Swift
func listTagsLogGroup(_ request: AWSLogsListTagsLogGroupRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the ListTagsLogGroup service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsListTagsLogGroupResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
The ListTagsLogGroup operation is on the path to deprecation. We recommend that you use ListTagsForResource instead.
Lists the tags for the specified log group.
See
AWSLogsListTagsLogGroupRequest
See
AWSLogsListTagsLogGroupResponse
Declaration
Objective-C
- (void)listTagsLogGroup:(nonnull AWSLogsListTagsLogGroupRequest *)request completionHandler: (void (^_Nullable)(AWSLogsListTagsLogGroupResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func listTagsLogGroup(_ request: AWSLogsListTagsLogGroupRequest) async throws -> AWSLogsListTagsLogGroupResponse
Parameters
request
A container for the necessary parameters to execute the ListTagsLogGroup service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
Creates an account-level data protection policy or subscription filter policy that applies to all log groups or a subset of log groups in the account.
Data protection policy
A data protection policy can help safeguard sensitive data that’s ingested by your log groups by auditing and masking the sensitive log data. Each account can have only one account-level data protection policy.
Sensitive data is detected and masked when it is ingested into a log group. When you set a data protection policy, log events ingested into the log groups before that time are not masked.
If you use
PutAccountPolicy
to create a data protection policy for your whole account, it applies to both existing log groups and all log groups that are created later in this account. The account-level policy is applied to existing log groups with eventual consistency. It might take up to 5 minutes before sensitive data in existing log groups begins to be masked.By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks. A user who has the
logs:Unmask
permission can use a GetLogEvents or FilterLogEvents operation with theunmask
parameter set totrue
to view the unmasked log events. Users with thelogs:Unmask
can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs Insights query with theunmask
query command.For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking.
To use the
PutAccountPolicy
operation for a data protection policy, you must be signed on with thelogs:PutDataProtectionPolicy
andlogs:PutAccountPolicy
permissions.The
PutAccountPolicy
operation applies to all log groups in the account. You can use PutDataProtectionPolicy to create a data protection policy that applies to just one log group. If a log group has its own data protection policy and the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term specified in either policy is masked.Subscription filter policy
A subscription filter policy sets up a real-time feed of log events from CloudWatch Logs to other Amazon Web Services services. Account-level subscription filter policies apply to both existing log groups and log groups that are created later in this account. Supported destinations are Kinesis Data Streams, Firehose, and Lambda. When log events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP format.
The following destinations are supported for subscription filters:
An Kinesis Data Streams data stream in the same account as the subscription policy, for same-account delivery.
An Firehose data stream in the same account as the subscription policy, for same-account delivery.
A Lambda function in the same account as the subscription policy, for same-account delivery.
A logical destination in a different account created with PutDestination, for cross-account delivery. Kinesis Data Streams and Firehose are supported as logical destinations.
Each account can have one account-level subscription filter policy. If you are updating an existing filter, you must specify the correct name in
PolicyName
. To perform aPutAccountPolicy
subscription filter operation for any destination except a Lambda function, you must also have theiam:PassRole
permission.See
AWSLogsPutAccountPolicyRequest
See
AWSLogsPutAccountPolicyResponse
Declaration
Objective-C
- (id)putAccountPolicy:(nonnull AWSLogsPutAccountPolicyRequest *)request;
Swift
func putAccountPolicy(_ request: AWSLogsPutAccountPolicyRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the PutAccountPolicy service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsPutAccountPolicyResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorOperationAborted
,AWSLogsErrorServiceUnavailable
,AWSLogsErrorLimitExceeded
. -
Creates an account-level data protection policy or subscription filter policy that applies to all log groups or a subset of log groups in the account.
Data protection policy
A data protection policy can help safeguard sensitive data that’s ingested by your log groups by auditing and masking the sensitive log data. Each account can have only one account-level data protection policy.
Sensitive data is detected and masked when it is ingested into a log group. When you set a data protection policy, log events ingested into the log groups before that time are not masked.
If you use
PutAccountPolicy
to create a data protection policy for your whole account, it applies to both existing log groups and all log groups that are created later in this account. The account-level policy is applied to existing log groups with eventual consistency. It might take up to 5 minutes before sensitive data in existing log groups begins to be masked.By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks. A user who has the
logs:Unmask
permission can use a GetLogEvents or FilterLogEvents operation with theunmask
parameter set totrue
to view the unmasked log events. Users with thelogs:Unmask
can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs Insights query with theunmask
query command.For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking.
To use the
PutAccountPolicy
operation for a data protection policy, you must be signed on with thelogs:PutDataProtectionPolicy
andlogs:PutAccountPolicy
permissions.The
PutAccountPolicy
operation applies to all log groups in the account. You can use PutDataProtectionPolicy to create a data protection policy that applies to just one log group. If a log group has its own data protection policy and the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term specified in either policy is masked.Subscription filter policy
A subscription filter policy sets up a real-time feed of log events from CloudWatch Logs to other Amazon Web Services services. Account-level subscription filter policies apply to both existing log groups and log groups that are created later in this account. Supported destinations are Kinesis Data Streams, Firehose, and Lambda. When log events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP format.
The following destinations are supported for subscription filters:
An Kinesis Data Streams data stream in the same account as the subscription policy, for same-account delivery.
An Firehose data stream in the same account as the subscription policy, for same-account delivery.
A Lambda function in the same account as the subscription policy, for same-account delivery.
A logical destination in a different account created with PutDestination, for cross-account delivery. Kinesis Data Streams and Firehose are supported as logical destinations.
Each account can have one account-level subscription filter policy. If you are updating an existing filter, you must specify the correct name in
PolicyName
. To perform aPutAccountPolicy
subscription filter operation for any destination except a Lambda function, you must also have theiam:PassRole
permission.See
AWSLogsPutAccountPolicyRequest
See
AWSLogsPutAccountPolicyResponse
Declaration
Objective-C
- (void)putAccountPolicy:(nonnull AWSLogsPutAccountPolicyRequest *)request completionHandler: (void (^_Nullable)(AWSLogsPutAccountPolicyResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func putAccountPolicy(_ request: AWSLogsPutAccountPolicyRequest) async throws -> AWSLogsPutAccountPolicyResponse
Parameters
request
A container for the necessary parameters to execute the PutAccountPolicy service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorOperationAborted
,AWSLogsErrorServiceUnavailable
,AWSLogsErrorLimitExceeded
. -
Creates a data protection policy for the specified log group. A data protection policy can help safeguard sensitive data that’s ingested by the log group by auditing and masking the sensitive log data.
Sensitive data is detected and masked when it is ingested into the log group. When you set a data protection policy, log events ingested into the log group before that time are not masked.
By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks. A user who has the
logs:Unmask
permission can use a GetLogEvents or FilterLogEvents operation with theunmask
parameter set totrue
to view the unmasked log events. Users with thelogs:Unmask
can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs Insights query with theunmask
query command.For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking.
The
PutDataProtectionPolicy
operation applies to only the specified log group. You can also use PutAccountPolicy to create an account-level data protection policy that applies to all log groups in the account, including both existing log groups and log groups that are created level. If a log group has its own data protection policy and the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term specified in either policy is masked.See
AWSLogsPutDataProtectionPolicyRequest
See
AWSLogsPutDataProtectionPolicyResponse
Declaration
Objective-C
- (id)putDataProtectionPolicy: (nonnull AWSLogsPutDataProtectionPolicyRequest *)request;
Swift
func putDataProtectionPolicy(_ request: AWSLogsPutDataProtectionPolicyRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the PutDataProtectionPolicy service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsPutDataProtectionPolicyResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorLimitExceeded
,AWSLogsErrorOperationAborted
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
Creates a data protection policy for the specified log group. A data protection policy can help safeguard sensitive data that’s ingested by the log group by auditing and masking the sensitive log data.
Sensitive data is detected and masked when it is ingested into the log group. When you set a data protection policy, log events ingested into the log group before that time are not masked.
By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks. A user who has the
logs:Unmask
permission can use a GetLogEvents or FilterLogEvents operation with theunmask
parameter set totrue
to view the unmasked log events. Users with thelogs:Unmask
can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs Insights query with theunmask
query command.For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking.
The
PutDataProtectionPolicy
operation applies to only the specified log group. You can also use PutAccountPolicy to create an account-level data protection policy that applies to all log groups in the account, including both existing log groups and log groups that are created level. If a log group has its own data protection policy and the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term specified in either policy is masked.See
AWSLogsPutDataProtectionPolicyRequest
See
AWSLogsPutDataProtectionPolicyResponse
Declaration
Objective-C
- (void)putDataProtectionPolicy: (nonnull AWSLogsPutDataProtectionPolicyRequest *)request completionHandler: (void (^_Nullable)( AWSLogsPutDataProtectionPolicyResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func putDataProtectionPolicy(_ request: AWSLogsPutDataProtectionPolicyRequest) async throws -> AWSLogsPutDataProtectionPolicyResponse
Parameters
request
A container for the necessary parameters to execute the PutDataProtectionPolicy service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorLimitExceeded
,AWSLogsErrorOperationAborted
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
Creates or updates a logical delivery destination. A delivery destination is an Amazon Web Services resource that represents an Amazon Web Services service that logs can be sent to. CloudWatch Logs, Amazon S3, and Firehose are supported as logs delivery destinations.
To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following:
Create a delivery source, which is a logical object that represents the resource that is actually sending the logs. For more information, see PutDeliverySource.
Use
PutDeliveryDestination
to create a delivery destination, which is a logical object that represents the actual delivery destination.If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.
Use
CreateDelivery
to create a delivery by pairing exactly one delivery source and one delivery destination. For more information, see CreateDelivery.
You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.
Only some Amazon Web Services services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services.
If you use this operation to update an existing delivery destination, all the current delivery destination parameters are overwritten with the new parameter values that you specify.
See
AWSLogsPutDeliveryDestinationRequest
See
AWSLogsPutDeliveryDestinationResponse
Declaration
Objective-C
- (id)putDeliveryDestination: (nonnull AWSLogsPutDeliveryDestinationRequest *)request;
Swift
func putDeliveryDestination(_ request: AWSLogsPutDeliveryDestinationRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the PutDeliveryDestination service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsPutDeliveryDestinationResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorServiceUnavailable
,AWSLogsErrorConflict
,AWSLogsErrorValidation
,AWSLogsErrorServiceQuotaExceeded
,AWSLogsErrorThrottling
,AWSLogsErrorResourceNotFound
. -
Creates or updates a logical delivery destination. A delivery destination is an Amazon Web Services resource that represents an Amazon Web Services service that logs can be sent to. CloudWatch Logs, Amazon S3, and Firehose are supported as logs delivery destinations.
To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following:
Create a delivery source, which is a logical object that represents the resource that is actually sending the logs. For more information, see PutDeliverySource.
Use
PutDeliveryDestination
to create a delivery destination, which is a logical object that represents the actual delivery destination.If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.
Use
CreateDelivery
to create a delivery by pairing exactly one delivery source and one delivery destination. For more information, see CreateDelivery.
You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.
Only some Amazon Web Services services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services.
If you use this operation to update an existing delivery destination, all the current delivery destination parameters are overwritten with the new parameter values that you specify.
See
AWSLogsPutDeliveryDestinationRequest
See
AWSLogsPutDeliveryDestinationResponse
Declaration
Objective-C
- (void)putDeliveryDestination: (nonnull AWSLogsPutDeliveryDestinationRequest *)request completionHandler: (void (^_Nullable)( AWSLogsPutDeliveryDestinationResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func putDeliveryDestination(_ request: AWSLogsPutDeliveryDestinationRequest) async throws -> AWSLogsPutDeliveryDestinationResponse
Parameters
request
A container for the necessary parameters to execute the PutDeliveryDestination service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorServiceUnavailable
,AWSLogsErrorConflict
,AWSLogsErrorValidation
,AWSLogsErrorServiceQuotaExceeded
,AWSLogsErrorThrottling
,AWSLogsErrorResourceNotFound
. -
Creates and assigns an IAM policy that grants permissions to CloudWatch Logs to deliver logs cross-account to a specified destination in this account. To configure the delivery of logs from an Amazon Web Services service in another account to a logs delivery destination in the current account, you must do the following:
Create a delivery source, which is a logical object that represents the resource that is actually sending the logs. For more information, see PutDeliverySource.
Create a delivery destination, which is a logical object that represents the actual delivery destination. For more information, see PutDeliveryDestination.
Use this operation in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.
Create a delivery by pairing exactly one delivery source and one delivery destination. For more information, see CreateDelivery.
Only some Amazon Web Services services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services.
The contents of the policy must include two statements. One statement enables general logs delivery, and the other allows delivery to the chosen destination. See the examples for the needed policies.
See
AWSLogsPutDeliveryDestinationPolicyRequest
See
AWSLogsPutDeliveryDestinationPolicyResponse
Declaration
Objective-C
- (id)putDeliveryDestinationPolicy: (nonnull AWSLogsPutDeliveryDestinationPolicyRequest *)request;
Swift
func putDeliveryDestinationPolicy(_ request: AWSLogsPutDeliveryDestinationPolicyRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the PutDeliveryDestinationPolicy service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsPutDeliveryDestinationPolicyResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorServiceUnavailable
,AWSLogsErrorValidation
,AWSLogsErrorResourceNotFound
,AWSLogsErrorConflict
. -
Creates and assigns an IAM policy that grants permissions to CloudWatch Logs to deliver logs cross-account to a specified destination in this account. To configure the delivery of logs from an Amazon Web Services service in another account to a logs delivery destination in the current account, you must do the following:
Create a delivery source, which is a logical object that represents the resource that is actually sending the logs. For more information, see PutDeliverySource.
Create a delivery destination, which is a logical object that represents the actual delivery destination. For more information, see PutDeliveryDestination.
Use this operation in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.
Create a delivery by pairing exactly one delivery source and one delivery destination. For more information, see CreateDelivery.
Only some Amazon Web Services services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services.
The contents of the policy must include two statements. One statement enables general logs delivery, and the other allows delivery to the chosen destination. See the examples for the needed policies.
See
AWSLogsPutDeliveryDestinationPolicyRequest
See
AWSLogsPutDeliveryDestinationPolicyResponse
Declaration
Objective-C
- (void) putDeliveryDestinationPolicy: (nonnull AWSLogsPutDeliveryDestinationPolicyRequest *)request completionHandler: (void (^_Nullable)( AWSLogsPutDeliveryDestinationPolicyResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func putDeliveryDestinationPolicy(_ request: AWSLogsPutDeliveryDestinationPolicyRequest) async throws -> AWSLogsPutDeliveryDestinationPolicyResponse
Parameters
request
A container for the necessary parameters to execute the PutDeliveryDestinationPolicy service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorServiceUnavailable
,AWSLogsErrorValidation
,AWSLogsErrorResourceNotFound
,AWSLogsErrorConflict
. -
Creates or updates a logical delivery source. A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose.
To configure logs delivery between a delivery destination and an Amazon Web Services service that is supported as a delivery source, you must do the following:
Use
PutDeliverySource
to create a delivery source, which is a logical object that represents the resource that is actually sending the logs.Use
PutDeliveryDestination
to create a delivery destination, which is a logical object that represents the actual delivery destination. For more information, see PutDeliveryDestination.If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.
Use
CreateDelivery
to create a delivery by pairing exactly one delivery source and one delivery destination. For more information, see CreateDelivery.
You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.
Only some Amazon Web Services services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services.
If you use this operation to update an existing delivery source, all the current delivery source parameters are overwritten with the new parameter values that you specify.
See
AWSLogsPutDeliverySourceRequest
See
AWSLogsPutDeliverySourceResponse
Declaration
Objective-C
- (id)putDeliverySource:(nonnull AWSLogsPutDeliverySourceRequest *)request;
Swift
func putDeliverySource(_ request: AWSLogsPutDeliverySourceRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the PutDeliverySource service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsPutDeliverySourceResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorServiceUnavailable
,AWSLogsErrorConflict
,AWSLogsErrorValidation
,AWSLogsErrorServiceQuotaExceeded
,AWSLogsErrorResourceNotFound
,AWSLogsErrorThrottling
. -
Creates or updates a logical delivery source. A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose.
To configure logs delivery between a delivery destination and an Amazon Web Services service that is supported as a delivery source, you must do the following:
Use
PutDeliverySource
to create a delivery source, which is a logical object that represents the resource that is actually sending the logs.Use
PutDeliveryDestination
to create a delivery destination, which is a logical object that represents the actual delivery destination. For more information, see PutDeliveryDestination.If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.
Use
CreateDelivery
to create a delivery by pairing exactly one delivery source and one delivery destination. For more information, see CreateDelivery.
You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.
Only some Amazon Web Services services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services.
If you use this operation to update an existing delivery source, all the current delivery source parameters are overwritten with the new parameter values that you specify.
See
AWSLogsPutDeliverySourceRequest
See
AWSLogsPutDeliverySourceResponse
Declaration
Objective-C
- (void)putDeliverySource:(nonnull AWSLogsPutDeliverySourceRequest *)request completionHandler: (void (^_Nullable)(AWSLogsPutDeliverySourceResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func putDeliverySource(_ request: AWSLogsPutDeliverySourceRequest) async throws -> AWSLogsPutDeliverySourceResponse
Parameters
request
A container for the necessary parameters to execute the PutDeliverySource service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorServiceUnavailable
,AWSLogsErrorConflict
,AWSLogsErrorValidation
,AWSLogsErrorServiceQuotaExceeded
,AWSLogsErrorResourceNotFound
,AWSLogsErrorThrottling
. -
Creates or updates a destination. This operation is used only to create destinations for cross-account subscriptions.
A destination encapsulates a physical resource (such as an Amazon Kinesis stream). With a destination, you can subscribe to a real-time stream of log events for a different account, ingested using PutLogEvents.
Through an access policy, a destination controls what is written to it. 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 afterPutDestination
.To perform a
PutDestination
operation, you must also have theiam:PassRole
permission.See
AWSLogsPutDestinationRequest
See
AWSLogsPutDestinationResponse
Declaration
Objective-C
- (id)putDestination:(nonnull AWSLogsPutDestinationRequest *)request;
Swift
func putDestination(_ request: AWSLogsPutDestinationRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the PutDestination service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsPutDestinationResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorOperationAborted
,AWSLogsErrorServiceUnavailable
. -
Creates or updates a destination. This operation is used only to create destinations for cross-account subscriptions.
A destination encapsulates a physical resource (such as an Amazon Kinesis stream). With a destination, you can subscribe to a real-time stream of log events for a different account, ingested using PutLogEvents.
Through an access policy, a destination controls what is written to it. 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 afterPutDestination
.To perform a
PutDestination
operation, you must also have theiam:PassRole
permission.See
AWSLogsPutDestinationRequest
See
AWSLogsPutDestinationResponse
Declaration
Objective-C
- (void)putDestination:(nonnull AWSLogsPutDestinationRequest *)request completionHandler: (void (^_Nullable)(AWSLogsPutDestinationResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func putDestination(_ request: AWSLogsPutDestinationRequest) async throws -> AWSLogsPutDestinationResponse
Parameters
request
A container for the necessary parameters to execute the PutDestination service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorOperationAborted
,AWSLogsErrorServiceUnavailable
. -
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.
See
AWSLogsPutDestinationPolicyRequest
Declaration
Objective-C
- (id)putDestinationPolicy: (nonnull AWSLogsPutDestinationPolicyRequest *)request;
Swift
func putDestinationPolicy(_ request: AWSLogsPutDestinationPolicyRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the PutDestinationPolicy service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorOperationAborted
,AWSLogsErrorServiceUnavailable
. -
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.
See
AWSLogsPutDestinationPolicyRequest
Declaration
Objective-C
- (void)putDestinationPolicy: (nonnull AWSLogsPutDestinationPolicyRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func putDestinationPolicy(_ request: AWSLogsPutDestinationPolicyRequest) async throws
Parameters
request
A container for the necessary parameters to execute the PutDestinationPolicy service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorOperationAborted
,AWSLogsErrorServiceUnavailable
. -
Uploads a batch of log events to the specified log stream.
The sequence token is now ignored in
PutLogEvents
actions.PutLogEvents
actions are always accepted and never returnInvalidSequenceTokenException
orDataAlreadyAcceptedException
even if the sequence token is not valid. You can use parallelPutLogEvents
actions on the same log stream.The batch of events must satisfy the following constraints:
The maximum batch size is 1,048,576 bytes. 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 more than 14 days in the past. Also, none of the log events can be from earlier than the retention period of the log group.
The log events in the batch must be in chronological order by their timestamp. The timestamp is the time that the event occurred, expressed as the number of milliseconds after
Jan 1, 1970 00:00:00 UTC
. (In Amazon Web Services Tools for PowerShell and the Amazon Web Services SDK for .NET, the timestamp is specified in .NET format:yyyy-mm-ddThh:mm:ss
. For example,2017-09-15T13:45:30
.)A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.
Each log event can be no larger than 256 KB.
The maximum number of log events in a batch is 10,000.
The quota of five requests per second per log stream has been removed. Instead,
PutLogEvents
actions are throttled based on a per-second per-account quota. You can request an increase to the per-second throttling quota by using the Service Quotas service.
If a call to
PutLogEvents
returns “UnrecognizedClientException” the most likely cause is a non-valid Amazon Web Services access key ID or secret key.See
AWSLogsPutLogEventsRequest
See
AWSLogsPutLogEventsResponse
Declaration
Objective-C
- (id)putLogEvents:(nonnull AWSLogsPutLogEventsRequest *)request;
Swift
func putLogEvents(_ request: AWSLogsPutLogEventsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the PutLogEvents service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsPutLogEventsResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorInvalidSequenceToken
,AWSLogsErrorDataAlreadyAccepted
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
,AWSLogsErrorUnrecognizedClient
. -
Uploads a batch of log events to the specified log stream.
The sequence token is now ignored in
PutLogEvents
actions.PutLogEvents
actions are always accepted and never returnInvalidSequenceTokenException
orDataAlreadyAcceptedException
even if the sequence token is not valid. You can use parallelPutLogEvents
actions on the same log stream.The batch of events must satisfy the following constraints:
The maximum batch size is 1,048,576 bytes. 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 more than 14 days in the past. Also, none of the log events can be from earlier than the retention period of the log group.
The log events in the batch must be in chronological order by their timestamp. The timestamp is the time that the event occurred, expressed as the number of milliseconds after
Jan 1, 1970 00:00:00 UTC
. (In Amazon Web Services Tools for PowerShell and the Amazon Web Services SDK for .NET, the timestamp is specified in .NET format:yyyy-mm-ddThh:mm:ss
. For example,2017-09-15T13:45:30
.)A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.
Each log event can be no larger than 256 KB.
The maximum number of log events in a batch is 10,000.
The quota of five requests per second per log stream has been removed. Instead,
PutLogEvents
actions are throttled based on a per-second per-account quota. You can request an increase to the per-second throttling quota by using the Service Quotas service.
If a call to
PutLogEvents
returns “UnrecognizedClientException” the most likely cause is a non-valid Amazon Web Services access key ID or secret key.See
AWSLogsPutLogEventsRequest
See
AWSLogsPutLogEventsResponse
Declaration
Objective-C
- (void)putLogEvents:(nonnull AWSLogsPutLogEventsRequest *)request completionHandler:(void (^_Nullable)(AWSLogsPutLogEventsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func putLogEvents(_ request: AWSLogsPutLogEventsRequest) async throws -> AWSLogsPutLogEventsResponse
Parameters
request
A container for the necessary parameters to execute the PutLogEvents service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorInvalidSequenceToken
,AWSLogsErrorDataAlreadyAccepted
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
,AWSLogsErrorUnrecognizedClient
. -
Creates or updates a metric filter and associates it with the specified log group. With metric filters, you can 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.
When you create a metric filter, you can also optionally assign a unit and dimensions to the metric that is created.
Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as
IPAddress
orrequestID
as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.CloudWatch Logs might disable a metric filter if it generates 1,000 different name/value pairs for your specified dimensions within one hour.
You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.
See
AWSLogsPutMetricFilterRequest
Declaration
Objective-C
- (id)putMetricFilter:(nonnull AWSLogsPutMetricFilterRequest *)request;
Swift
func putMetricFilter(_ request: AWSLogsPutMetricFilterRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the PutMetricFilter service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorOperationAborted
,AWSLogsErrorLimitExceeded
,AWSLogsErrorServiceUnavailable
. -
Creates or updates a metric filter and associates it with the specified log group. With metric filters, you can 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.
When you create a metric filter, you can also optionally assign a unit and dimensions to the metric that is created.
Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as
IPAddress
orrequestID
as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.CloudWatch Logs might disable a metric filter if it generates 1,000 different name/value pairs for your specified dimensions within one hour.
You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.
See
AWSLogsPutMetricFilterRequest
Declaration
Objective-C
- (void)putMetricFilter:(nonnull AWSLogsPutMetricFilterRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func putMetricFilter(_ request: AWSLogsPutMetricFilterRequest) async throws
Parameters
request
A container for the necessary parameters to execute the PutMetricFilter service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorOperationAborted
,AWSLogsErrorLimitExceeded
,AWSLogsErrorServiceUnavailable
. -
Creates or updates a query definition for CloudWatch Logs Insights. For more information, see Analyzing Log Data with CloudWatch Logs Insights.
To update a query definition, specify its
queryDefinitionId
in your request. The values ofname
,queryString
, andlogGroupNames
are changed to the values that you specify in your update operation. No current values are retained from the current query definition. For example, imagine updating a current query definition that includes log groups. If you don’t specify thelogGroupNames
parameter in your update operation, the query definition changes to contain no log groups.You must have the
logs:PutQueryDefinition
permission to be able to perform this operation.See
AWSLogsPutQueryDefinitionRequest
See
AWSLogsPutQueryDefinitionResponse
Declaration
Objective-C
- (id)putQueryDefinition:(nonnull AWSLogsPutQueryDefinitionRequest *)request;
Swift
func putQueryDefinition(_ request: AWSLogsPutQueryDefinitionRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the PutQueryDefinition service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsPutQueryDefinitionResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorLimitExceeded
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
Creates or updates a query definition for CloudWatch Logs Insights. For more information, see Analyzing Log Data with CloudWatch Logs Insights.
To update a query definition, specify its
queryDefinitionId
in your request. The values ofname
,queryString
, andlogGroupNames
are changed to the values that you specify in your update operation. No current values are retained from the current query definition. For example, imagine updating a current query definition that includes log groups. If you don’t specify thelogGroupNames
parameter in your update operation, the query definition changes to contain no log groups.You must have the
logs:PutQueryDefinition
permission to be able to perform this operation.See
AWSLogsPutQueryDefinitionRequest
See
AWSLogsPutQueryDefinitionResponse
Declaration
Objective-C
- (void)putQueryDefinition:(nonnull AWSLogsPutQueryDefinitionRequest *)request completionHandler: (void (^_Nullable)(AWSLogsPutQueryDefinitionResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func putQueryDefinition(_ request: AWSLogsPutQueryDefinitionRequest) async throws -> AWSLogsPutQueryDefinitionResponse
Parameters
request
A container for the necessary parameters to execute the PutQueryDefinition service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorLimitExceeded
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
Creates or updates a resource policy allowing other Amazon Web Services services to put log events to this account, such as Amazon Route 53. An account can have up to 10 resource policies per Amazon Web Services Region.
See
AWSLogsPutResourcePolicyRequest
See
AWSLogsPutResourcePolicyResponse
Declaration
Objective-C
- (id)putResourcePolicy:(nonnull AWSLogsPutResourcePolicyRequest *)request;
Swift
func putResourcePolicy(_ request: AWSLogsPutResourcePolicyRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the PutResourcePolicy service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsPutResourcePolicyResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorLimitExceeded
,AWSLogsErrorServiceUnavailable
. -
Creates or updates a resource policy allowing other Amazon Web Services services to put log events to this account, such as Amazon Route 53. An account can have up to 10 resource policies per Amazon Web Services Region.
See
AWSLogsPutResourcePolicyRequest
See
AWSLogsPutResourcePolicyResponse
Declaration
Objective-C
- (void)putResourcePolicy:(nonnull AWSLogsPutResourcePolicyRequest *)request completionHandler: (void (^_Nullable)(AWSLogsPutResourcePolicyResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func putResourcePolicy(_ request: AWSLogsPutResourcePolicyRequest) async throws -> AWSLogsPutResourcePolicyResponse
Parameters
request
A container for the necessary parameters to execute the PutResourcePolicy service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorLimitExceeded
,AWSLogsErrorServiceUnavailable
. -
Sets the retention of the specified log group. With a retention policy, you can configure the number of days for which to retain log events in the specified log group.
CloudWatch Logs doesn’t immediately delete log events when they reach their retention setting. It typically takes up to 72 hours after that before log events are deleted, but in rare situations might take longer.
To illustrate, imagine that you change a log group to have a longer retention setting when it contains log events that are past the expiration date, but haven’t been deleted. Those log events will take up to 72 hours to be deleted after the new retention date is reached. To make sure that log data is deleted permanently, keep a log group at its lower retention setting until 72 hours after the previous retention period ends. Alternatively, wait to change the retention setting until you confirm that the earlier log events are deleted.
When log events reach their retention setting they are marked for deletion. After they are marked for deletion, they do not add to your archival storage costs anymore, even if they are not actually deleted until later. These log events marked for deletion are also not included when you use an API to retrieve the
storedBytes
value to see how many bytes a log group is storing.See
AWSLogsPutRetentionPolicyRequest
Declaration
Objective-C
- (id)putRetentionPolicy:(nonnull AWSLogsPutRetentionPolicyRequest *)request;
Swift
func putRetentionPolicy(_ request: AWSLogsPutRetentionPolicyRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the PutRetentionPolicy service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorOperationAborted
,AWSLogsErrorServiceUnavailable
. -
Sets the retention of the specified log group. With a retention policy, you can configure the number of days for which to retain log events in the specified log group.
CloudWatch Logs doesn’t immediately delete log events when they reach their retention setting. It typically takes up to 72 hours after that before log events are deleted, but in rare situations might take longer.
To illustrate, imagine that you change a log group to have a longer retention setting when it contains log events that are past the expiration date, but haven’t been deleted. Those log events will take up to 72 hours to be deleted after the new retention date is reached. To make sure that log data is deleted permanently, keep a log group at its lower retention setting until 72 hours after the previous retention period ends. Alternatively, wait to change the retention setting until you confirm that the earlier log events are deleted.
When log events reach their retention setting they are marked for deletion. After they are marked for deletion, they do not add to your archival storage costs anymore, even if they are not actually deleted until later. These log events marked for deletion are also not included when you use an API to retrieve the
storedBytes
value to see how many bytes a log group is storing.See
AWSLogsPutRetentionPolicyRequest
Declaration
Objective-C
- (void)putRetentionPolicy:(nonnull AWSLogsPutRetentionPolicyRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func putRetentionPolicy(_ request: AWSLogsPutRetentionPolicyRequest) async throws
Parameters
request
A container for the necessary parameters to execute the PutRetentionPolicy service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorOperationAborted
,AWSLogsErrorServiceUnavailable
. -
Creates or updates a subscription filter and associates it with the specified log group. With subscription filters, you can subscribe to a real-time stream of log events ingested through PutLogEvents and have them delivered to a specific destination. When log events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP format.
The following destinations are supported for subscription filters:
An Amazon Kinesis data stream belonging to the same account as the subscription filter, for same-account delivery.
A logical destination created with PutDestination that belongs to a different account, for cross-account delivery. We currently support Kinesis Data Streams and Firehose as logical destinations.
An Amazon Kinesis Data Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.
An Lambda function that belongs to the same account as the subscription filter, for same-account delivery.
Each log group can have up to two subscription filters associated with it. If you are updating an existing filter, you must specify the correct name in
filterName
.To perform a
PutSubscriptionFilter
operation for any destination except a Lambda function, you must also have theiam:PassRole
permission.See
AWSLogsPutSubscriptionFilterRequest
Declaration
Objective-C
- (id)putSubscriptionFilter: (nonnull AWSLogsPutSubscriptionFilterRequest *)request;
Swift
func putSubscriptionFilter(_ request: AWSLogsPutSubscriptionFilterRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the PutSubscriptionFilter service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorOperationAborted
,AWSLogsErrorLimitExceeded
,AWSLogsErrorServiceUnavailable
. -
Creates or updates a subscription filter and associates it with the specified log group. With subscription filters, you can subscribe to a real-time stream of log events ingested through PutLogEvents and have them delivered to a specific destination. When log events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP format.
The following destinations are supported for subscription filters:
An Amazon Kinesis data stream belonging to the same account as the subscription filter, for same-account delivery.
A logical destination created with PutDestination that belongs to a different account, for cross-account delivery. We currently support Kinesis Data Streams and Firehose as logical destinations.
An Amazon Kinesis Data Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.
An Lambda function that belongs to the same account as the subscription filter, for same-account delivery.
Each log group can have up to two subscription filters associated with it. If you are updating an existing filter, you must specify the correct name in
filterName
.To perform a
PutSubscriptionFilter
operation for any destination except a Lambda function, you must also have theiam:PassRole
permission.See
AWSLogsPutSubscriptionFilterRequest
Declaration
Objective-C
- (void)putSubscriptionFilter: (nonnull AWSLogsPutSubscriptionFilterRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func putSubscriptionFilter(_ request: AWSLogsPutSubscriptionFilterRequest) async throws
Parameters
request
A container for the necessary parameters to execute the PutSubscriptionFilter service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorOperationAborted
,AWSLogsErrorLimitExceeded
,AWSLogsErrorServiceUnavailable
. -
Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group and time range to query and the query string to use.
For more information, see CloudWatch Logs Insights Query Syntax.
After you run a query using
StartQuery
, the query results are stored by CloudWatch Logs. You can use GetQueryResults to retrieve the results of a query, using thequeryId
thatStartQuery
returns.If you have associated a KMS key with the query results in this account, then StartQuery uses that key to encrypt the results when it stores them. If no key is associated with query results, the query results are encrypted with the default CloudWatch Logs encryption method.
Queries time out after 60 minutes of runtime. If your queries are timing out, reduce the time range being searched or partition your query into a number of queries.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start a query in a linked source account. For more information, see CloudWatch cross-account observability. For a cross-account
StartQuery
operation, the query definition must be defined in the monitoring account.You can have up to 30 concurrent CloudWatch Logs insights queries, including queries that have been added to dashboards.
See
AWSLogsStartQueryRequest
See
AWSLogsStartQueryResponse
Declaration
Objective-C
- (id)startQuery:(nonnull AWSLogsStartQueryRequest *)request;
Swift
func startQuery(_ request: AWSLogsStartQueryRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the StartQuery service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsStartQueryResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorMalformedQuery
,AWSLogsErrorInvalidParameter
,AWSLogsErrorLimitExceeded
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group and time range to query and the query string to use.
For more information, see CloudWatch Logs Insights Query Syntax.
After you run a query using
StartQuery
, the query results are stored by CloudWatch Logs. You can use GetQueryResults to retrieve the results of a query, using thequeryId
thatStartQuery
returns.If you have associated a KMS key with the query results in this account, then StartQuery uses that key to encrypt the results when it stores them. If no key is associated with query results, the query results are encrypted with the default CloudWatch Logs encryption method.
Queries time out after 60 minutes of runtime. If your queries are timing out, reduce the time range being searched or partition your query into a number of queries.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start a query in a linked source account. For more information, see CloudWatch cross-account observability. For a cross-account
StartQuery
operation, the query definition must be defined in the monitoring account.You can have up to 30 concurrent CloudWatch Logs insights queries, including queries that have been added to dashboards.
See
AWSLogsStartQueryRequest
See
AWSLogsStartQueryResponse
Declaration
Objective-C
- (void)startQuery:(nonnull AWSLogsStartQueryRequest *)request completionHandler:(void (^_Nullable)(AWSLogsStartQueryResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func startQuery(_ request: AWSLogsStartQueryRequest) async throws -> AWSLogsStartQueryResponse
Parameters
request
A container for the necessary parameters to execute the StartQuery service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorMalformedQuery
,AWSLogsErrorInvalidParameter
,AWSLogsErrorLimitExceeded
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
Stops a CloudWatch Logs Insights query that is in progress. If the query has already ended, the operation returns an error indicating that the specified query is not running.
See
AWSLogsStopQueryRequest
See
AWSLogsStopQueryResponse
Declaration
Objective-C
- (id)stopQuery:(nonnull AWSLogsStopQueryRequest *)request;
Swift
func stopQuery(_ request: AWSLogsStopQueryRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the StopQuery service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsStopQueryResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
Stops a CloudWatch Logs Insights query that is in progress. If the query has already ended, the operation returns an error indicating that the specified query is not running.
See
AWSLogsStopQueryRequest
See
AWSLogsStopQueryResponse
Declaration
Objective-C
- (void)stopQuery:(nonnull AWSLogsStopQueryRequest *)request completionHandler:(void (^_Nullable)(AWSLogsStopQueryResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func stopQuery(_ request: AWSLogsStopQueryRequest) async throws -> AWSLogsStopQueryResponse
Parameters
request
A container for the necessary parameters to execute the StopQuery service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
The TagLogGroup operation is on the path to deprecation. We recommend that you use TagResource instead.
Adds or updates the specified tags for the specified log group.
To list the tags for a log group, use ListTagsForResource. To remove tags, use UntagResource.
For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs in the Amazon CloudWatch Logs User Guide.
CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using the
aws:Resource/key-name
oraws:TagKeys
condition keys. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.See
AWSLogsTagLogGroupRequest
Declaration
Objective-C
- (id)tagLogGroup:(nonnull AWSLogsTagLogGroupRequest *)request;
Swift
func tagLogGroup(_ request: AWSLogsTagLogGroupRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the TagLogGroup service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorResourceNotFound
,AWSLogsErrorInvalidParameter
. -
The TagLogGroup operation is on the path to deprecation. We recommend that you use TagResource instead.
Adds or updates the specified tags for the specified log group.
To list the tags for a log group, use ListTagsForResource. To remove tags, use UntagResource.
For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs in the Amazon CloudWatch Logs User Guide.
CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using the
aws:Resource/key-name
oraws:TagKeys
condition keys. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.See
AWSLogsTagLogGroupRequest
Declaration
Objective-C
- (void)tagLogGroup:(nonnull AWSLogsTagLogGroupRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func tagLogGroup(_ request: AWSLogsTagLogGroupRequest) async throws
Parameters
request
A container for the necessary parameters to execute the TagLogGroup service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorResourceNotFound
,AWSLogsErrorInvalidParameter
. -
Assigns one or more tags (key-value pairs) to the specified CloudWatch Logs resource. Currently, the only CloudWatch Logs resources that can be tagged are log groups and destinations.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don’t have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can use the
TagResource
action with a resource that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.You can associate as many as 50 tags with a CloudWatch Logs resource.
See
AWSLogsTagResourceRequest
Declaration
Objective-C
- (id)tagResource:(nonnull AWSLogsTagResourceRequest *)request;
Swift
func tagResource(_ request: AWSLogsTagResourceRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the TagResource service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
,AWSLogsErrorTooManyTags
. -
Assigns one or more tags (key-value pairs) to the specified CloudWatch Logs resource. Currently, the only CloudWatch Logs resources that can be tagged are log groups and destinations.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don’t have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can use the
TagResource
action with a resource that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.You can associate as many as 50 tags with a CloudWatch Logs resource.
See
AWSLogsTagResourceRequest
Declaration
Objective-C
- (void)tagResource:(nonnull AWSLogsTagResourceRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func tagResource(_ request: AWSLogsTagResourceRequest) async throws
Parameters
request
A container for the necessary parameters to execute the TagResource service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
,AWSLogsErrorTooManyTags
. -
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.
See
AWSLogsTestMetricFilterRequest
See
AWSLogsTestMetricFilterResponse
Declaration
Objective-C
- (id)testMetricFilter:(nonnull AWSLogsTestMetricFilterRequest *)request;
Swift
func testMetricFilter(_ request: AWSLogsTestMetricFilterRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the TestMetricFilter service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSLogsTestMetricFilterResponse
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorServiceUnavailable
. -
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.
See
AWSLogsTestMetricFilterRequest
See
AWSLogsTestMetricFilterResponse
Declaration
Objective-C
- (void)testMetricFilter:(nonnull AWSLogsTestMetricFilterRequest *)request completionHandler: (void (^_Nullable)(AWSLogsTestMetricFilterResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func testMetricFilter(_ request: AWSLogsTestMetricFilterRequest) async throws -> AWSLogsTestMetricFilterResponse
Parameters
request
A container for the necessary parameters to execute the TestMetricFilter service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorServiceUnavailable
. -
The UntagLogGroup operation is on the path to deprecation. We recommend that you use UntagResource instead.
Removes the specified tags from the specified log group.
To list the tags for a log group, use ListTagsForResource. To add tags, use TagResource.
CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using the
aws:Resource/key-name
oraws:TagKeys
condition keys.See
AWSLogsUntagLogGroupRequest
Declaration
Objective-C
- (id)untagLogGroup:(nonnull AWSLogsUntagLogGroupRequest *)request;
Swift
func untagLogGroup(_ request: AWSLogsUntagLogGroupRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the UntagLogGroup service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorResourceNotFound
. -
The UntagLogGroup operation is on the path to deprecation. We recommend that you use UntagResource instead.
Removes the specified tags from the specified log group.
To list the tags for a log group, use ListTagsForResource. To add tags, use TagResource.
CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using the
aws:Resource/key-name
oraws:TagKeys
condition keys.See
AWSLogsUntagLogGroupRequest
Declaration
Objective-C
- (void)untagLogGroup:(nonnull AWSLogsUntagLogGroupRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func untagLogGroup(_ request: AWSLogsUntagLogGroupRequest) async throws
Parameters
request
A container for the necessary parameters to execute the UntagLogGroup service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorResourceNotFound
. -
Removes one or more tags from the specified resource.
See
AWSLogsUntagResourceRequest
Declaration
Objective-C
- (id)untagResource:(nonnull AWSLogsUntagResourceRequest *)request;
Swift
func untagResource(_ request: AWSLogsUntagResourceRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the UntagResource service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
Removes one or more tags from the specified resource.
See
AWSLogsUntagResourceRequest
Declaration
Objective-C
- (void)untagResource:(nonnull AWSLogsUntagResourceRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func untagResource(_ request: AWSLogsUntagResourceRequest) async throws
Parameters
request
A container for the necessary parameters to execute the UntagResource service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
. -
Use this operation to suppress anomaly detection for a specified anomaly or pattern. If you suppress an anomaly, CloudWatch Logs won’t report new occurrences of that anomaly and won’t update that anomaly with new data. If you suppress a pattern, CloudWatch Logs won’t report any anomalies related to that pattern.
You must specify either
anomalyId
orpatternId
, but you can’t specify both parameters in the same operation.If you have previously used this operation to suppress detection of a pattern or anomaly, you can use it again to cause CloudWatch Logs to end the suppression. To do this, use this operation and specify the anomaly or pattern to stop suppressing, and omit the
suppressionType
andsuppressionPeriod
parameters.See
AWSLogsUpdateAnomalyRequest
Declaration
Objective-C
- (id)updateAnomaly:(nonnull AWSLogsUpdateAnomalyRequest *)request;
Swift
func updateAnomaly(_ request: AWSLogsUpdateAnomalyRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the UpdateAnomaly service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
,AWSLogsErrorOperationAborted
. -
Use this operation to suppress anomaly detection for a specified anomaly or pattern. If you suppress an anomaly, CloudWatch Logs won’t report new occurrences of that anomaly and won’t update that anomaly with new data. If you suppress a pattern, CloudWatch Logs won’t report any anomalies related to that pattern.
You must specify either
anomalyId
orpatternId
, but you can’t specify both parameters in the same operation.If you have previously used this operation to suppress detection of a pattern or anomaly, you can use it again to cause CloudWatch Logs to end the suppression. To do this, use this operation and specify the anomaly or pattern to stop suppressing, and omit the
suppressionType
andsuppressionPeriod
parameters.See
AWSLogsUpdateAnomalyRequest
Declaration
Objective-C
- (void)updateAnomaly:(nonnull AWSLogsUpdateAnomalyRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func updateAnomaly(_ request: AWSLogsUpdateAnomalyRequest) async throws
Parameters
request
A container for the necessary parameters to execute the UpdateAnomaly service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
,AWSLogsErrorOperationAborted
. -
Updates an existing log anomaly detector.
See
AWSLogsUpdateLogAnomalyDetectorRequest
Declaration
Objective-C
- (id)updateLogAnomalyDetector: (nonnull AWSLogsUpdateLogAnomalyDetectorRequest *)request;
Swift
func updateLogAnomalyDetector(_ request: AWSLogsUpdateLogAnomalyDetectorRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the UpdateLogAnomalyDetector service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
,AWSLogsErrorOperationAborted
. -
Updates an existing log anomaly detector.
See
AWSLogsUpdateLogAnomalyDetectorRequest
Declaration
Objective-C
- (void)updateLogAnomalyDetector: (nonnull AWSLogsUpdateLogAnomalyDetectorRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func updateLogAnomalyDetector(_ request: AWSLogsUpdateLogAnomalyDetectorRequest) async throws
Parameters
request
A container for the necessary parameters to execute the UpdateLogAnomalyDetector service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSLogsErrorDomain
domain and the following error code:AWSLogsErrorInvalidParameter
,AWSLogsErrorResourceNotFound
,AWSLogsErrorServiceUnavailable
,AWSLogsErrorOperationAborted
.