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, 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 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 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 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.

  • 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 Key Management Service customer master key (CMK) with the specified log group.

    Associating an 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 CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.

    CloudWatch Logs supports only symmetric CMKs. Do not use an associate an asymmetric CMK with your log group. 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 CMK with a log group but the CMK does not exist or the CMK 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 be nil. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceNotFound, AWSLogsErrorOperationAborted, AWSLogsErrorServiceUnavailable.

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

    Associating an 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 CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.

    CloudWatch Logs supports only symmetric CMKs. Do not use an associate an asymmetric CMK with your log group. 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 CMK with a log group but the CMK does not exist or the CMK 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, 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.

  • Cancels the specified export task.

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

  • Cancels the specified export task.

    The task must be in the PENDING or RUNNING 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, 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.

  • Creates an export task, which allows you to 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 Amazon S3 buckets that are encrypted by KMS is not supported. Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is not 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 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.

    Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can sort the exported log fild 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 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.

  • Creates an export task, which allows you to 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 Amazon S3 buckets that are encrypted by KMS is not supported. Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is not 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 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.

    Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can sort the exported log fild 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, 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.

  • Creates a log group with the specified name. You can create up to 20,000 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 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)

    When you create a log group, by default the log events in the log group never expire. To set a retention policy so that events expire and are deleted after a specified time, use PutRetentionPolicy.

    If you associate a Key Management Service 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 CloudWatch Logs. This enables 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 receive an InvalidParameterException error.

    CloudWatch Logs supports only symmetric CMKs. Do not associate an asymmetric CMK 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 be nil. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceAlreadyExists, AWSLogsErrorLimitExceeded, AWSLogsErrorOperationAborted, AWSLogsErrorServiceUnavailable.

  • Creates a log group with the specified name. You can create up to 20,000 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 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)

    When you create a log group, by default the log events in the log group never expire. To set a retention policy so that events expire and are deleted after a specified time, use PutRetentionPolicy.

    If you associate a Key Management Service 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 CloudWatch Logs. This enables 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 receive an InvalidParameterException error.

    CloudWatch Logs supports only symmetric CMKs. Do not associate an asymmetric CMK 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, 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.

  • 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.

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

    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 be nil. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain 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.

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

    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, 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.

  • 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 be nil. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain 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, 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.

  • 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 be nil. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain 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, 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.

  • 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 be nil. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain 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, 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.

  • 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 be nil. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain 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, 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.

  • 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 of AWSLogsDeleteQueryDefinitionResponse. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain 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, 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.

  • 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 be nil. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain 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, 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.

  • 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 be nil. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain 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, 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.

  • 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 be nil. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain 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, 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.

  • 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 of AWSLogsDescribeDestinationsResponse. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain 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, 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.

  • 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 of AWSLogsDescribeExportTasksResponse. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain 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, 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.

  • 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 the aws:ResourceTag/key-name condition key. Other CloudWatch Logs actions do support the use of the aws: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.

    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 of AWSLogsDescribeLogGroupsResponse. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain 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 the aws:ResourceTag/key-name condition key. Other CloudWatch Logs actions do support the use of the aws: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.

    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, 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.

  • 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.

    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 of AWSLogsDescribeLogStreamsResponse. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain 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.

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

    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, 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.

  • 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 of AWSLogsDescribeMetricFiltersResponse. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain 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, 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.

  • Returns a list of CloudWatch Logs Insights queries that are scheduled, executing, or have been executed 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 of AWSLogsDescribeQueriesResponse. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorResourceNotFound, AWSLogsErrorServiceUnavailable.

  • Returns a list of CloudWatch Logs Insights queries that are scheduled, executing, or have been executed 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, 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.

  • This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions.

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

  • This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions.

    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, 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.

  • 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 of AWSLogsDescribeResourcePoliciesResponse. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain 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, 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.

  • 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 of AWSLogsDescribeSubscriptionFiltersResponse. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain 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, 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.

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

    After the KMS CMK is disassociated from the log group, CloudWatch Logs stops encrypting newly ingested data for the log group. All previously ingested data remains encrypted, and 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.

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

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

    After the KMS CMK is disassociated from the log group, CloudWatch Logs stops encrypting newly ingested data for the log group. All previously ingested data remains encrypted, and 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.

    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, 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.

  • 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. 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.

    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 of AWSLogsFilterLogEventsResponse. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain 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.

    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. 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.

    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, 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.

  • 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.

    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 of AWSLogsGetLogEventsResponse. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain 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.

    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, 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.

  • Returns a list of the fields that are included in log events in the specified log group, along with the percentage of log events that contain each field. The search is limited to a time period that you specify.

    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.

    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 of AWSLogsGetLogGroupFieldsResponse. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain 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, along with the percentage of log events that contain each field. The search is limited to a time period that you specify.

    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.

    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, 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, 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 of AWSLogsGetLogRecordResponse. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain 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, 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, 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 a query execution. To run a query, use StartQuery.

    If the value of the Status field in the output is Running, this operation returns only partial results. If you see a value of Scheduled or Running for the status, you can retry the operation later to see the final results.

    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 of AWSLogsGetQueryResultsResponse. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain 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 a query execution. To run a query, use StartQuery.

    If the value of the Status field in the output is Running, this operation returns only partial results. If you see a value of Scheduled or Running for the status, you can retry the operation later to see the final results.

    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, 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.

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

  • 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, 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.

  • 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) and enables you to 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 after PutDestination.

    To perform a PutDestination operation, you must also have the iam: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 of AWSLogsPutDestinationResponse. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain 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) and enables you to 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 after PutDestination.

    To perform a PutDestination operation, you must also have the iam: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, 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.

  • 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.

    If multiple Amazon Web Services accounts are sending logs to this destination, each sender account must be listed separately in the policy. The policy does not support specifying * as the Principal or the use of the aws:PrincipalOrgId global key.

    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 be nil. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain 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.

    If multiple Amazon Web Services accounts are sending logs to this destination, each sender account must be listed separately in the policy. The policy does not support specifying * as the Principal or the use of the aws:PrincipalOrgId global key.

    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, 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.

  • 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 in the expectedSequenceToken field from InvalidSequenceTokenException. If you call PutLogEvents twice within a narrow time period using the same value for sequenceToken, both calls might be successful or one might be rejected.

    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 older than 14 days or older 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 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.

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

    • There is a quota of 5 requests per second per log stream. Additional requests are throttled. This quota can’t be changed.

    If a call to PutLogEvents returns “UnrecognizedClientException” the most likely cause is an invalid 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 of AWSLogsPutLogEventsResponse. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorInvalidParameter, AWSLogsErrorInvalidSequenceToken, AWSLogsErrorDataAlreadyAccepted, AWSLogsErrorResourceNotFound, AWSLogsErrorServiceUnavailable, AWSLogsErrorUnrecognizedClient.

  • 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 in the expectedSequenceToken field from InvalidSequenceTokenException. If you call PutLogEvents twice within a narrow time period using the same value for sequenceToken, both calls might be successful or one might be rejected.

    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 older than 14 days or older 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 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.

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

    • There is a quota of 5 requests per second per log stream. Additional requests are throttled. This quota can’t be changed.

    If a call to PutLogEvents returns “UnrecognizedClientException” the most likely cause is an invalid 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, 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, AWSLogsErrorUnrecognizedClient.

  • 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.

    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 or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.

    To help prevent accidental high charges, Amazon disables a metric filter if it generates 1000 different name/value pairs for the dimensions that you have specified within a certain amount of time.

    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 be nil. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain 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. 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.

    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 or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.

    To help prevent accidental high charges, Amazon disables a metric filter if it generates 1000 different name/value pairs for the dimensions that you have specified within a certain amount of time.

    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, 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.

  • 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 of name, queryString, and logGroupNames are changed to the values that you specify in your update operation. No current values are retained from the current query definition. For example, if you update a current query definition that includes log groups, and you don’t specify the logGroupNames 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 of AWSLogsPutQueryDefinitionResponse. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain 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 of name, queryString, and logGroupNames are changed to the values that you specify in your update operation. No current values are retained from the current query definition. For example, if you update a current query definition that includes log groups, and you don’t specify the logGroupNames 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, 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, 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 of AWSLogsPutResourcePolicyResponse. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain 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, 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.

  • 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.

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

  • 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.

    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, 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.

  • 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. 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 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 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, you must also have the iam: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 be nil. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain 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. 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. 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 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 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, you must also have the iam: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, 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.

  • 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.

    Queries time out after 15 minutes of execution. If your queries are timing out, reduce the time range being searched or partition your query into a number of queries.

    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 of AWSLogsStartQueryResponse. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain 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.

    Queries time out after 15 minutes of execution. If your queries are timing out, reduce the time range being searched or partition your query into a number of queries.

    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, 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: 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 of AWSLogsStopQueryResponse. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain 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, 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.

  • 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.

    CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using the aws:Resource/key-name or aws: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 be nil. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorResourceNotFound, AWSLogsErrorInvalidParameter.

  • 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.

    CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using the aws:Resource/key-name or aws: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, 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.

  • 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 of AWSLogsTestMetricFilterResponse. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain 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, 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.

  • Removes the specified tags from the specified log group.

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

    CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using the aws:Resource/key-name or aws: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 be nil. On failed execution, task.error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorResourceNotFound.

  • Removes the specified tags from the specified log group.

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

    CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using the aws:Resource/key-name or aws: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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLogsErrorDomain domain and the following error code: AWSLogsErrorResourceNotFound.