AWSLogs Class Reference

Inherits from AWSService : NSObject
Declared in AWSLogsService.h
AWSLogsService.m

Overview

You can use Amazon CloudWatch Logs to monitor, store, and access your log files from Amazon EC2 instances, AWS CloudTrail, or other sources. You can then retrieve the associated log data from CloudWatch Logs using the CloudWatch console, CloudWatch Logs commands in the AWS 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 and 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") or 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 AWS CloudTrail logged events: You can create alarms in CloudWatch and receive notifications of particular API activity as captured by CloudTrail and 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 older than this setting are automatically deleted. The CloudWatch Logs agent makes it easy 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.

  configuration

The service configuration used to instantiate this service client.

@property (nonatomic, strong, readonly) AWSServiceConfiguration *configuration

Discussion

Warning: Once the client is instantiated, do not modify the configuration object. It may cause unspecified behaviors.

Declared In

AWSLogsService.h

+ defaultLogs

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.

+ (instancetype)defaultLogs

Return Value

The default service client.

Discussion

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];

Declared In

AWSLogsService.h

+ registerLogsWithConfiguration:forKey:

Creates a service client with the given service configuration and registers it for the key.

+ (void)registerLogsWithConfiguration:(AWSServiceConfiguration *)configuration forKey:(NSString *)key

Parameters

configuration

A service configuration object.

key

A string to identify the service client.

Discussion

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.

Declared In

AWSLogsService.h

+ LogsForKey:

Retrieves the service client associated with the key. You need to call + registerLogsWithConfiguration:forKey: before invoking this method.

+ (instancetype)LogsForKey:(NSString *)key

Parameters

key

A string to identify the service client.

Return Value

An instance of the service client.

Discussion

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"];

Declared In

AWSLogsService.h

+ removeLogsForKey:

Removes the service client associated with the key and release it.

+ (void)removeLogsForKey:(NSString *)key

Parameters

key

A string to identify the service client.

Discussion

Warning: Before calling this method, make sure no method is running on this client.

Declared In

AWSLogsService.h

– associateKmsKey:

Associates the specified AWS Key Management Service (AWS KMS) customer master key (CMK) with the specified log group.

Associating an AWS KMS CMK with a log group overrides any existing associations between the log group and a CMK. After a CMK is associated with a log group, all newly ingested data for the log group is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs. This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.

Note that it can take up to 5 minutes for this operation to take effect.

If you attempt to associate a CMK with a log group but the CMK does not exist or the CMK is disabled, you will receive an InvalidParameterException error.

- (AWSTask *)associateKmsKey:(AWSLogsAssociateKmsKeyRequest *)request

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 be nil. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceNotFound, AWSLogsErrorOperationAborted, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– associateKmsKey:completionHandler:

Associates the specified AWS Key Management Service (AWS KMS) customer master key (CMK) with the specified log group.

Associating an AWS KMS CMK with a log group overrides any existing associations between the log group and a CMK. After a CMK is associated with a log group, all newly ingested data for the log group is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs. This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.

Note that it can take up to 5 minutes for this operation to take effect.

If you attempt to associate a CMK with a log group but the CMK does not exist or the CMK is disabled, you will receive an InvalidParameterException error.

- (void)associateKmsKey:(AWSLogsAssociateKmsKeyRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceNotFound, AWSLogsErrorOperationAborted, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– cancelExportTask:

Cancels the specified export task.

The task must be in the PENDING or RUNNING state.

- (AWSTask *)cancelExportTask:(AWSLogsCancelExportTaskRequest *)request

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 be nil. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceNotFound, AWSLogsErrorInvalidOperation, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– cancelExportTask:completionHandler:

Cancels the specified export task.

The task must be in the PENDING or RUNNING state.

- (void)cancelExportTask:(AWSLogsCancelExportTaskRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceNotFound, AWSLogsErrorInvalidOperation, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– createExportTask:

Creates an export task, which allows you to efficiently export data from a log group to an Amazon S3 bucket.

This is an asynchronous call. If all the required information is provided, this operation initiates an export task and responds with the ID of the task. After the task has started, you can use DescribeExportTasks to get the status of the export task. Each account can only have one active (RUNNING or PENDING) export task at a time. To cancel an export task, use CancelExportTask.

You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate out log data for each export task, you can specify a prefix to be used as the Amazon S3 key prefix for all exported objects.

- (AWSTask<AWSLogsCreateExportTaskResponse*> *)createExportTask:(AWSLogsCreateExportTaskRequest *)request

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 of AWSLogsCreateExportTaskResponse. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorLimitExceeded, AWSLogsErrorOperationAborted, AWSLogsErrorServiceUnavailable, AWSLogsErrorResourceNotFound, AWSLogsErrorResourceAlreadyExists.

Declared In

AWSLogsService.h

– createExportTask:completionHandler:

Creates an export task, which allows you to efficiently export data from a log group to an Amazon S3 bucket.

This is an asynchronous call. If all the required information is provided, this operation initiates an export task and responds with the ID of the task. After the task has started, you can use DescribeExportTasks to get the status of the export task. Each account can only have one active (RUNNING or PENDING) export task at a time. To cancel an export task, use CancelExportTask.

You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate out log data for each export task, you can specify a prefix to be used as the Amazon S3 key prefix for all exported objects.

- (void)createExportTask:(AWSLogsCreateExportTaskRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSLogsCreateExportTaskResponse *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorLimitExceeded, AWSLogsErrorOperationAborted, AWSLogsErrorServiceUnavailable, AWSLogsErrorResourceNotFound, AWSLogsErrorResourceAlreadyExists.

Declared In

AWSLogsService.h

– createLogGroup:

Creates a log group with the specified name.

You can create up to 5000 log groups per account.

You must use the following guidelines when naming a log group:

  • Log group names must be unique within a region for an AWS account.

  • Log group names can be between 1 and 512 characters long.

  • Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).

If you associate a AWS Key Management Service (AWS KMS) customer master key (CMK) with the log group, ingested data is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs. This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.

If you attempt to associate a CMK with the log group but the CMK does not exist or the CMK is disabled, you will receive an InvalidParameterException error.

- (AWSTask *)createLogGroup:(AWSLogsCreateLogGroupRequest *)request

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 be nil. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceAlreadyExists, AWSLogsErrorLimitExceeded, AWSLogsErrorOperationAborted, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– createLogGroup:completionHandler:

Creates a log group with the specified name.

You can create up to 5000 log groups per account.

You must use the following guidelines when naming a log group:

  • Log group names must be unique within a region for an AWS account.

  • Log group names can be between 1 and 512 characters long.

  • Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).

If you associate a AWS Key Management Service (AWS KMS) customer master key (CMK) with the log group, ingested data is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs. This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.

If you attempt to associate a CMK with the log group but the CMK does not exist or the CMK is disabled, you will receive an InvalidParameterException error.

- (void)createLogGroup:(AWSLogsCreateLogGroupRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceAlreadyExists, AWSLogsErrorLimitExceeded, AWSLogsErrorOperationAborted, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– createLogStream:

Creates a log stream for the specified log group.

There is no limit on the number of log streams that you can create for a log group.

You must use the following guidelines when naming a log stream:

  • Log stream names must be unique within the log group.

  • Log stream names can be between 1 and 512 characters long.

  • The ':' (colon) and '*' (asterisk) characters are not allowed.

- (AWSTask *)createLogStream:(AWSLogsCreateLogStreamRequest *)request

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 be nil. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceAlreadyExists, AWSLogsErrorResourceNotFound, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– createLogStream:completionHandler:

Creates a log stream for the specified log group.

There is no limit on the number of log streams that you can create for a log group.

You must use the following guidelines when naming a log stream:

  • Log stream names must be unique within the log group.

  • Log stream names can be between 1 and 512 characters long.

  • The ':' (colon) and '*' (asterisk) characters are not allowed.

- (void)createLogStream:(AWSLogsCreateLogStreamRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceAlreadyExists, AWSLogsErrorResourceNotFound, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– deleteDestination:

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.

- (AWSTask *)deleteDestination:(AWSLogsDeleteDestinationRequest *)request

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 be nil. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceNotFound, AWSLogsErrorOperationAborted, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– deleteDestination:completionHandler:

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.

- (void)deleteDestination:(AWSLogsDeleteDestinationRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceNotFound, AWSLogsErrorOperationAborted, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– deleteLogGroup:

Deletes the specified log group and permanently deletes all the archived log events associated with the log group.

- (AWSTask *)deleteLogGroup:(AWSLogsDeleteLogGroupRequest *)request

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 be nil. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceNotFound, AWSLogsErrorOperationAborted, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– deleteLogGroup:completionHandler:

Deletes the specified log group and permanently deletes all the archived log events associated with the log group.

- (void)deleteLogGroup:(AWSLogsDeleteLogGroupRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceNotFound, AWSLogsErrorOperationAborted, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– deleteLogStream:

Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream.

- (AWSTask *)deleteLogStream:(AWSLogsDeleteLogStreamRequest *)request

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 be nil. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceNotFound, AWSLogsErrorOperationAborted, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– deleteLogStream:completionHandler:

Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream.

- (void)deleteLogStream:(AWSLogsDeleteLogStreamRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceNotFound, AWSLogsErrorOperationAborted, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– deleteMetricFilter:

Deletes the specified metric filter.

- (AWSTask *)deleteMetricFilter:(AWSLogsDeleteMetricFilterRequest *)request

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 be nil. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceNotFound, AWSLogsErrorOperationAborted, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– deleteMetricFilter:completionHandler:

Deletes the specified metric filter.

- (void)deleteMetricFilter:(AWSLogsDeleteMetricFilterRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceNotFound, AWSLogsErrorOperationAborted, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– deleteResourcePolicy:

Deletes a resource policy from this account. This revokes the access of the identities in that policy to put log events to this account.

- (AWSTask *)deleteResourcePolicy:(AWSLogsDeleteResourcePolicyRequest *)request

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 be nil. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceNotFound, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– deleteResourcePolicy:completionHandler:

Deletes a resource policy from this account. This revokes the access of the identities in that policy to put log events to this account.

- (void)deleteResourcePolicy:(AWSLogsDeleteResourcePolicyRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceNotFound, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– deleteRetentionPolicy:

Deletes the specified retention policy.

Log events do not expire if they belong to log groups without a retention policy.

- (AWSTask *)deleteRetentionPolicy:(AWSLogsDeleteRetentionPolicyRequest *)request

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 be nil. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceNotFound, AWSLogsErrorOperationAborted, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– deleteRetentionPolicy:completionHandler:

Deletes the specified retention policy.

Log events do not expire if they belong to log groups without a retention policy.

- (void)deleteRetentionPolicy:(AWSLogsDeleteRetentionPolicyRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceNotFound, AWSLogsErrorOperationAborted, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– deleteSubscriptionFilter:

Deletes the specified subscription filter.

- (AWSTask *)deleteSubscriptionFilter:(AWSLogsDeleteSubscriptionFilterRequest *)request

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 be nil. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceNotFound, AWSLogsErrorOperationAborted, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– deleteSubscriptionFilter:completionHandler:

Deletes the specified subscription filter.

- (void)deleteSubscriptionFilter:(AWSLogsDeleteSubscriptionFilterRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceNotFound, AWSLogsErrorOperationAborted, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– describeDestinations:

Lists all your destinations. The results are ASCII-sorted by destination name.

- (AWSTask<AWSLogsDescribeDestinationsResponse*> *)describeDestinations:(AWSLogsDescribeDestinationsRequest *)request

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 of AWSLogsDescribeDestinationsResponse. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– describeDestinations:completionHandler:

Lists all your destinations. The results are ASCII-sorted by destination name.

- (void)describeDestinations:(AWSLogsDescribeDestinationsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSLogsDescribeDestinationsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– describeExportTasks:

Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.

- (AWSTask<AWSLogsDescribeExportTasksResponse*> *)describeExportTasks:(AWSLogsDescribeExportTasksRequest *)request

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 of AWSLogsDescribeExportTasksResponse. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– describeExportTasks:completionHandler:

Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.

- (void)describeExportTasks:(AWSLogsDescribeExportTasksRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSLogsDescribeExportTasksResponse *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– describeLogGroups:

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.

- (AWSTask<AWSLogsDescribeLogGroupsResponse*> *)describeLogGroups:(AWSLogsDescribeLogGroupsRequest *)request

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 of AWSLogsDescribeLogGroupsResponse. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– describeLogGroups:completionHandler:

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.

- (void)describeLogGroups:(AWSLogsDescribeLogGroupsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSLogsDescribeLogGroupsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– describeLogStreams:

Lists the log streams for the specified log group. You can list all the log streams or filter the results by prefix. You can also control how the results are ordered.

This operation has a limit of five transactions per second, after which transactions are throttled.

- (AWSTask<AWSLogsDescribeLogStreamsResponse*> *)describeLogStreams:(AWSLogsDescribeLogStreamsRequest *)request

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 of AWSLogsDescribeLogStreamsResponse. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceNotFound, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– describeLogStreams:completionHandler:

Lists the log streams for the specified log group. You can list all the log streams or filter the results by prefix. You can also control how the results are ordered.

This operation has a limit of five transactions per second, after which transactions are throttled.

- (void)describeLogStreams:(AWSLogsDescribeLogStreamsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSLogsDescribeLogStreamsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceNotFound, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– describeMetricFilters:

Lists the specified metric filters. You can list all the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.

- (AWSTask<AWSLogsDescribeMetricFiltersResponse*> *)describeMetricFilters:(AWSLogsDescribeMetricFiltersRequest *)request

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 of AWSLogsDescribeMetricFiltersResponse. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceNotFound, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– describeMetricFilters:completionHandler:

Lists the specified metric filters. You can list all the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.

- (void)describeMetricFilters:(AWSLogsDescribeMetricFiltersRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSLogsDescribeMetricFiltersResponse *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceNotFound, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– describeResourcePolicies:

Lists the resource policies in this account.

- (AWSTask<AWSLogsDescribeResourcePoliciesResponse*> *)describeResourcePolicies:(AWSLogsDescribeResourcePoliciesRequest *)request

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 of AWSLogsDescribeResourcePoliciesResponse. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– describeResourcePolicies:completionHandler:

Lists the resource policies in this account.

- (void)describeResourcePolicies:(AWSLogsDescribeResourcePoliciesRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSLogsDescribeResourcePoliciesResponse *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– describeSubscriptionFilters:

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.

- (AWSTask<AWSLogsDescribeSubscriptionFiltersResponse*> *)describeSubscriptionFilters:(AWSLogsDescribeSubscriptionFiltersRequest *)request

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 of AWSLogsDescribeSubscriptionFiltersResponse. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceNotFound, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– describeSubscriptionFilters:completionHandler:

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.

- (void)describeSubscriptionFilters:(AWSLogsDescribeSubscriptionFiltersRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSLogsDescribeSubscriptionFiltersResponse *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceNotFound, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– disassociateKmsKey:

Disassociates the associated AWS Key Management Service (AWS KMS) customer master key (CMK) from the specified log group.

After the AWS KMS CMK is disassociated from the log group, AWS CloudWatch Logs stops encrypting newly ingested data for the log group. All previously ingested data remains encrypted, and AWS CloudWatch Logs requires permissions for the CMK whenever the encrypted data is requested.

Note that it can take up to 5 minutes for this operation to take effect.

- (AWSTask *)disassociateKmsKey:(AWSLogsDisassociateKmsKeyRequest *)request

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 be nil. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceNotFound, AWSLogsErrorOperationAborted, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– disassociateKmsKey:completionHandler:

Disassociates the associated AWS Key Management Service (AWS KMS) customer master key (CMK) from the specified log group.

After the AWS KMS CMK is disassociated from the log group, AWS CloudWatch Logs stops encrypting newly ingested data for the log group. All previously ingested data remains encrypted, and AWS CloudWatch Logs requires permissions for the CMK whenever the encrypted data is requested.

Note that it can take up to 5 minutes for this operation to take effect.

- (void)disassociateKmsKey:(AWSLogsDisassociateKmsKeyRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceNotFound, AWSLogsErrorOperationAborted, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– filterLogEvents:

Lists log events from the specified log group. You can list all the log events or filter the results using a filter pattern, a time range, and the name of the log stream.

By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events), or all the events found within the time range that you specify. If the results include a token, then there are more log events available, and you can get additional results by specifying the token in a subsequent call.

- (AWSTask<AWSLogsFilterLogEventsResponse*> *)filterLogEvents:(AWSLogsFilterLogEventsRequest *)request

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 of AWSLogsFilterLogEventsResponse. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceNotFound, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– filterLogEvents:completionHandler:

Lists log events from the specified log group. You can list all the log events or filter the results using a filter pattern, a time range, and the name of the log stream.

By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events), or all the events found within the time range that you specify. If the results include a token, then there are more log events available, and you can get additional results by specifying the token in a subsequent call.

- (void)filterLogEvents:(AWSLogsFilterLogEventsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSLogsFilterLogEventsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceNotFound, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– getLogEvents:

Lists log events from the specified log stream. You can list all the log events or filter using a time range.

By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). You can get additional log events by specifying one of the tokens in a subsequent call.

- (AWSTask<AWSLogsGetLogEventsResponse*> *)getLogEvents:(AWSLogsGetLogEventsRequest *)request

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 of AWSLogsGetLogEventsResponse. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceNotFound, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– getLogEvents:completionHandler:

Lists log events from the specified log stream. You can list all the log events or filter using a time range.

By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). You can get additional log events by specifying one of the tokens in a subsequent call.

- (void)getLogEvents:(AWSLogsGetLogEventsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSLogsGetLogEventsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceNotFound, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– listTagsLogGroup:

Lists the tags for the specified log group.

- (AWSTask<AWSLogsListTagsLogGroupResponse*> *)listTagsLogGroup:(AWSLogsListTagsLogGroupRequest *)request

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 of AWSLogsListTagsLogGroupResponse. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorResourceNotFound, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– listTagsLogGroup:completionHandler:

Lists the tags for the specified log group.

- (void)listTagsLogGroup:(AWSLogsListTagsLogGroupRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSLogsListTagsLogGroupResponse *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorResourceNotFound, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– putDestination:

Creates or updates a destination. A destination encapsulates a physical resource (such as an Amazon Kinesis stream) and enables you to subscribe to a real-time stream of log events for a different account, ingested using PutLogEvents. Currently, the only supported physical resource is a Kinesis stream belonging to the same account as the destination.

Through an access policy, a destination controls what is written to its Kinesis stream. By default, PutDestination does not set any access policy with the destination, which means a cross-account user cannot call PutSubscriptionFilter against this destination. To enable this, the destination owner must call PutDestinationPolicy after PutDestination.

- (AWSTask<AWSLogsPutDestinationResponse*> *)putDestination:(AWSLogsPutDestinationRequest *)request

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 of AWSLogsPutDestinationResponse. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorOperationAborted, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– putDestination:completionHandler:

Creates or updates a destination. A destination encapsulates a physical resource (such as an Amazon Kinesis stream) and enables you to subscribe to a real-time stream of log events for a different account, ingested using PutLogEvents. Currently, the only supported physical resource is a Kinesis stream belonging to the same account as the destination.

Through an access policy, a destination controls what is written to its Kinesis stream. By default, PutDestination does not set any access policy with the destination, which means a cross-account user cannot call PutSubscriptionFilter against this destination. To enable this, the destination owner must call PutDestinationPolicy after PutDestination.

- (void)putDestination:(AWSLogsPutDestinationRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSLogsPutDestinationResponse *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorOperationAborted, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– putDestinationPolicy:

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.

- (AWSTask *)putDestinationPolicy:(AWSLogsPutDestinationPolicyRequest *)request

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 be nil. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorOperationAborted, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– putDestinationPolicy:completionHandler:

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.

- (void)putDestinationPolicy:(AWSLogsPutDestinationPolicyRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorOperationAborted, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– putLogEvents:

Uploads a batch of log events to the specified log stream.

You must include the sequence token obtained from the response of the previous call. An upload in a newly created log stream does not require a sequence token. You can also get the sequence token using DescribeLogStreams. If you call PutLogEvents twice within a narrow time period using the same value for sequenceToken, both calls may be successful, or one may be rejected.

The batch of events must satisfy the following constraints:

  • The maximum batch size is 1,048,576 bytes, and this size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.

  • None of the log events in the batch can be more than 2 hours in the future.

  • None of the log events in the batch can be older than 14 days or the retention period of the log group.

  • The log events in the batch must be in chronological ordered by their time stamp (the time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC).

  • The maximum number of log events in a batch is 10,000.

  • A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.

- (AWSTask<AWSLogsPutLogEventsResponse*> *)putLogEvents:(AWSLogsPutLogEventsRequest *)request

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 of AWSLogsPutLogEventsResponse. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorInvalidSequenceToken, AWSLogsErrorDataAlreadyAccepted, AWSLogsErrorResourceNotFound, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– putLogEvents:completionHandler:

Uploads a batch of log events to the specified log stream.

You must include the sequence token obtained from the response of the previous call. An upload in a newly created log stream does not require a sequence token. You can also get the sequence token using DescribeLogStreams. If you call PutLogEvents twice within a narrow time period using the same value for sequenceToken, both calls may be successful, or one may be rejected.

The batch of events must satisfy the following constraints:

  • The maximum batch size is 1,048,576 bytes, and this size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.

  • None of the log events in the batch can be more than 2 hours in the future.

  • None of the log events in the batch can be older than 14 days or the retention period of the log group.

  • The log events in the batch must be in chronological ordered by their time stamp (the time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC).

  • The maximum number of log events in a batch is 10,000.

  • A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.

- (void)putLogEvents:(AWSLogsPutLogEventsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSLogsPutLogEventsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorInvalidSequenceToken, AWSLogsErrorDataAlreadyAccepted, AWSLogsErrorResourceNotFound, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– putMetricFilter:

Creates or updates a metric filter and associates it with the specified log group. Metric filters allow you to configure rules to extract metric data from log events ingested through PutLogEvents.

The maximum number of metric filters that can be associated with a log group is 100.

- (AWSTask *)putMetricFilter:(AWSLogsPutMetricFilterRequest *)request

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 be nil. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceNotFound, AWSLogsErrorOperationAborted, AWSLogsErrorLimitExceeded, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– putMetricFilter:completionHandler:

Creates or updates a metric filter and associates it with the specified log group. Metric filters allow you to configure rules to extract metric data from log events ingested through PutLogEvents.

The maximum number of metric filters that can be associated with a log group is 100.

- (void)putMetricFilter:(AWSLogsPutMetricFilterRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceNotFound, AWSLogsErrorOperationAborted, AWSLogsErrorLimitExceeded, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– putResourcePolicy:

Creates or updates a resource policy allowing other AWS services to put log events to this account, such as Amazon Route 53. An account can have up to 50 resource policies per region.

- (AWSTask<AWSLogsPutResourcePolicyResponse*> *)putResourcePolicy:(AWSLogsPutResourcePolicyRequest *)request

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 of AWSLogsPutResourcePolicyResponse. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorLimitExceeded, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– putResourcePolicy:completionHandler:

Creates or updates a resource policy allowing other AWS services to put log events to this account, such as Amazon Route 53. An account can have up to 50 resource policies per region.

- (void)putResourcePolicy:(AWSLogsPutResourcePolicyRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSLogsPutResourcePolicyResponse *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorLimitExceeded, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– putRetentionPolicy:

Sets the retention of the specified log group. A retention policy allows you to configure the number of days for which to retain log events in the specified log group.

- (AWSTask *)putRetentionPolicy:(AWSLogsPutRetentionPolicyRequest *)request

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 be nil. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceNotFound, AWSLogsErrorOperationAborted, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– putRetentionPolicy:completionHandler:

Sets the retention of the specified log group. A retention policy allows you to configure the number of days for which to retain log events in the specified log group.

- (void)putRetentionPolicy:(AWSLogsPutRetentionPolicyRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceNotFound, AWSLogsErrorOperationAborted, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– putSubscriptionFilter:

Creates or updates a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events ingested through PutLogEvents and have them delivered to a specific destination. Currently, the supported destinations are:

  • An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.

  • A logical destination that belongs to a different account, for cross-account delivery.

  • An Amazon Kinesis Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.

  • An AWS Lambda function that belongs to the same account as the subscription filter, for same-account delivery.

There can only be one subscription filter associated with a log group. If you are updating an existing filter, you must specify the correct name in filterName. Otherwise, the call fails because you cannot associate a second filter with a log group.

- (AWSTask *)putSubscriptionFilter:(AWSLogsPutSubscriptionFilterRequest *)request

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 be nil. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceNotFound, AWSLogsErrorOperationAborted, AWSLogsErrorLimitExceeded, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– putSubscriptionFilter:completionHandler:

Creates or updates a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events ingested through PutLogEvents and have them delivered to a specific destination. Currently, the supported destinations are:

  • An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.

  • A logical destination that belongs to a different account, for cross-account delivery.

  • An Amazon Kinesis Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.

  • An AWS Lambda function that belongs to the same account as the subscription filter, for same-account delivery.

There can only be one subscription filter associated with a log group. If you are updating an existing filter, you must specify the correct name in filterName. Otherwise, the call fails because you cannot associate a second filter with a log group.

- (void)putSubscriptionFilter:(AWSLogsPutSubscriptionFilterRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceNotFound, AWSLogsErrorOperationAborted, AWSLogsErrorLimitExceeded, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– tagLogGroup:

Adds or updates the specified tags for the specified log group.

To list the tags for a log group, use ListTagsLogGroup. To remove tags, use UntagLogGroup.

For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs in the Amazon CloudWatch Logs User Guide.

- (AWSTask *)tagLogGroup:(AWSLogsTagLogGroupRequest *)request

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 be nil. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorResourceNotFound, AWSLogsErrorInvalidParameter.

Declared In

AWSLogsService.h

– tagLogGroup:completionHandler:

Adds or updates the specified tags for the specified log group.

To list the tags for a log group, use ListTagsLogGroup. To remove tags, use UntagLogGroup.

For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs in the Amazon CloudWatch Logs User Guide.

- (void)tagLogGroup:(AWSLogsTagLogGroupRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorResourceNotFound, AWSLogsErrorInvalidParameter.

Declared In

AWSLogsService.h

– testMetricFilter:

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.

- (AWSTask<AWSLogsTestMetricFilterResponse*> *)testMetricFilter:(AWSLogsTestMetricFilterRequest *)request

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 of AWSLogsTestMetricFilterResponse. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– testMetricFilter:completionHandler:

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.

- (void)testMetricFilter:(AWSLogsTestMetricFilterRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSLogsTestMetricFilterResponse *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorServiceUnavailable.

Declared In

AWSLogsService.h

– untagLogGroup:

Removes the specified tags from the specified log group.

To list the tags for a log group, use ListTagsLogGroup. To add tags, use UntagLogGroup.

- (AWSTask *)untagLogGroup:(AWSLogsUntagLogGroupRequest *)request

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 be nil. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorResourceNotFound.

Declared In

AWSLogsService.h

– untagLogGroup:completionHandler:

Removes the specified tags from the specified log group.

To list the tags for a log group, use ListTagsLogGroup. To add tags, use UntagLogGroup.

- (void)untagLogGroup:(AWSLogsUntagLogGroupRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorResourceNotFound.

Declared In

AWSLogsService.h