AWSLogsFilterLogEventsRequest

Objective-C

@interface AWSLogsFilterLogEventsRequest

Swift

class AWSLogsFilterLogEventsRequest

  • The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not returned.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable endTime;

    Swift

    var endTime: NSNumber? { get set }

  • The filter pattern to use. For more information, see Filter and Pattern Syntax.

    If not provided, all the events are matched.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable filterPattern;

    Swift

    var filterPattern: String? { get set }

  • If the value is true, the operation attempts to provide responses that contain events from multiple log streams within the log group, interleaved in a single response. If the value is false, all the matched log events in the first log stream are searched first, then those in the next log stream, and so on.

    Important As of June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable interleaved;

    Swift

    var interleaved: NSNumber? { get set }

  • The maximum number of events to return. The default is 10,000 events.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable limit;

    Swift

    var limit: NSNumber? { get set }

  • Specify either the name or ARN of the log group to view log events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.

    You must include either logGroupIdentifier or logGroupName, but not both.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable logGroupIdentifier;

    Swift

    var logGroupIdentifier: String? { get set }

  • The name of the log group to search.

    You must include either logGroupIdentifier or logGroupName, but not both.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable logGroupName;

    Swift

    var logGroupName: String? { get set }

  • Filters the results to include only events from log streams that have names starting with this prefix.

    If you specify a value for both logStreamNamePrefix and logStreamNames, but the value for logStreamNamePrefix does not match any log stream names specified in logStreamNames, the action returns an InvalidParameterException error.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable logStreamNamePrefix;

    Swift

    var logStreamNamePrefix: String? { get set }

  • Filters the results to only logs from the log streams in this list.

    If you specify a value for both logStreamNamePrefix and logStreamNames, the action returns an InvalidParameterException error.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable logStreamNames;

    Swift

    var logStreamNames: [String]? { get set }

  • The token for the next set of events to return. (You received this token from a previous call.)

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable nextToken;

    Swift

    var nextToken: String? { get set }

  • The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp before this time are not returned.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable startTime;

    Swift

    var startTime: NSNumber? { get set }

  • Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false.

    To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable unmask;

    Swift

    var unmask: NSNumber? { get set }