@datafire/amazonaws_logs NPM

@datafire/amazonaws_logs

Client library for Amazon CloudWatch Logs

Installation and Usage

npm install --save @datafire/amazonaws_logs

let amazonaws_logs = require('@datafire/amazonaws_logs').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_logs.AssociateKmsKey({
  "logGroupName": "",
  "kmsKeyId": ""
}).then(data => {
  console.log(data);
});

Description

Actions

AssociateKmsKey

amazonaws_logs.AssociateKmsKey({
  "logGroupName": "",
  "kmsKeyId": ""
}, context)

Input

input object
- kmsKeyId required KmsKeyId
- logGroupName required LogGroupName

Output

Output schema unknown

CancelExportTask

amazonaws_logs.CancelExportTask({
  "taskId": ""
}, context)

Input

input object
- taskId required ExportTaskId

Output

Output schema unknown

CreateExportTask

amazonaws_logs.CreateExportTask({
  "logGroupName": "",
  "from": 0,
  "to": 0,
  "destination": ""
}, context)

Input

input object
- destination required ExportDestinationBucket
- destinationPrefix ExportDestinationPrefix
- from required Timestamp
- logGroupName required LogGroupName
- logStreamNamePrefix LogStreamName
- taskName ExportTaskName
- to required Timestamp

Output

output CreateExportTaskResponse

CreateLogGroup

amazonaws_logs.CreateLogGroup({
  "logGroupName": ""
}, context)

Input

input object
- kmsKeyId KmsKeyId
- logGroupName required LogGroupName
- tags Tags

Output

Output schema unknown

CreateLogStream

amazonaws_logs.CreateLogStream({
  "logGroupName": "",
  "logStreamName": ""
}, context)

Input

input object
- logGroupName required LogGroupName
- logStreamName required LogStreamName

Output

Output schema unknown

DeleteDestination

amazonaws_logs.DeleteDestination({
  "destinationName": ""
}, context)

Input

input object
- destinationName required DestinationName

Output

Output schema unknown

DeleteLogGroup

amazonaws_logs.DeleteLogGroup({
  "logGroupName": ""
}, context)

Input

input object
- logGroupName required LogGroupName

Output

Output schema unknown

DeleteLogStream

amazonaws_logs.DeleteLogStream({
  "logGroupName": "",
  "logStreamName": ""
}, context)

Input

input object
- logGroupName required LogGroupName
- logStreamName required LogStreamName

Output

Output schema unknown

DeleteMetricFilter

amazonaws_logs.DeleteMetricFilter({
  "logGroupName": "",
  "filterName": ""
}, context)

Input

input object
- filterName required FilterName
- logGroupName required LogGroupName

Output

Output schema unknown

DeleteResourcePolicy

amazonaws_logs.DeleteResourcePolicy({}, context)

Input

input object
- policyName PolicyName

Output

Output schema unknown

DeleteRetentionPolicy

amazonaws_logs.DeleteRetentionPolicy({
  "logGroupName": ""
}, context)

Input

input object
- logGroupName required LogGroupName

Output

Output schema unknown

DeleteSubscriptionFilter

amazonaws_logs.DeleteSubscriptionFilter({
  "logGroupName": "",
  "filterName": ""
}, context)

Input

input object
- filterName required FilterName
- logGroupName required LogGroupName

Output

Output schema unknown

DescribeDestinations

amazonaws_logs.DescribeDestinations({}, context)

Input

input object
- limit string
- nextToken string
- DestinationNamePrefix DestinationName
- limit DescribeLimit
- nextToken NextToken

Output

output DescribeDestinationsResponse

DescribeExportTasks

amazonaws_logs.DescribeExportTasks({}, context)

Input

input object
- limit DescribeLimit
- nextToken NextToken
- statusCode ExportTaskStatusCode
- taskId ExportTaskId

Output

output DescribeExportTasksResponse

DescribeLogGroups

amazonaws_logs.DescribeLogGroups({}, context)

Input

input object
- limit string
- nextToken string
- limit DescribeLimit
- logGroupNamePrefix LogGroupName
- nextToken NextToken

Output

output DescribeLogGroupsResponse

DescribeLogStreams

amazonaws_logs.DescribeLogStreams({
  "logGroupName": ""
}, context)

Input

input object
- limit string
- nextToken string
- descending Descending
- limit DescribeLimit
- logGroupName required LogGroupName
- logStreamNamePrefix LogStreamName
- nextToken NextToken
- orderBy OrderBy

Output

output DescribeLogStreamsResponse

DescribeMetricFilters

amazonaws_logs.DescribeMetricFilters({}, context)

Input

input object
- limit string
- nextToken string
- filterNamePrefix FilterName
- limit DescribeLimit
- logGroupName LogGroupName
- metricName MetricName
- metricNamespace MetricNamespace
- nextToken NextToken

Output

output DescribeMetricFiltersResponse

DescribeResourcePolicies

amazonaws_logs.DescribeResourcePolicies({}, context)

Input

input object
- limit DescribeLimit
- nextToken NextToken

Output

output DescribeResourcePoliciesResponse

DescribeSubscriptionFilters

amazonaws_logs.DescribeSubscriptionFilters({
  "logGroupName": ""
}, context)

Input

input object
- limit string
- nextToken string
- filterNamePrefix FilterName
- limit DescribeLimit
- logGroupName required LogGroupName
- nextToken NextToken

Output

output DescribeSubscriptionFiltersResponse

DisassociateKmsKey

amazonaws_logs.DisassociateKmsKey({
  "logGroupName": ""
}, context)

Input

input object
- logGroupName required LogGroupName

Output

Output schema unknown

FilterLogEvents

amazonaws_logs.FilterLogEvents({
  "logGroupName": ""
}, context)

Input

input object
- limit string
- nextToken string
- endTime Timestamp
- filterPattern FilterPattern
- interleaved Interleaved
- limit EventsLimit
- logGroupName required LogGroupName
- logStreamNames InputLogStreamNames
- nextToken NextToken
- startTime Timestamp

Output

output FilterLogEventsResponse

GetLogEvents

amazonaws_logs.GetLogEvents({
  "logGroupName": "",
  "logStreamName": ""
}, context)

Input

input object
- limit string
- nextToken string
- endTime Timestamp
- limit EventsLimit
- logGroupName required LogGroupName
- logStreamName required LogStreamName
- nextToken NextToken
- startFromHead StartFromHead
- startTime Timestamp

Output

output GetLogEventsResponse

ListTagsLogGroup

amazonaws_logs.ListTagsLogGroup({
  "logGroupName": ""
}, context)

Input

input object
- logGroupName required LogGroupName

Output

output ListTagsLogGroupResponse

PutDestination

amazonaws_logs.PutDestination({
  "destinationName": "",
  "targetArn": "",
  "roleArn": ""
}, context)

Input

input object
- destinationName required DestinationName
- roleArn required RoleArn
- targetArn required TargetArn

Output

output PutDestinationResponse

PutDestinationPolicy

amazonaws_logs.PutDestinationPolicy({
  "destinationName": "",
  "accessPolicy": ""
}, context)

Input

input object
- accessPolicy required AccessPolicy
- destinationName required DestinationName

Output

Output schema unknown

PutLogEvents

amazonaws_logs.PutLogEvents({
  "logGroupName": "",
  "logStreamName": "",
  "logEvents": []
}, context)

Input

input object
- logEvents required InputLogEvents
- logGroupName required LogGroupName
- logStreamName required LogStreamName
- sequenceToken SequenceToken

Output

output PutLogEventsResponse

PutMetricFilter

amazonaws_logs.PutMetricFilter({
  "logGroupName": "",
  "filterName": "",
  "filterPattern": "",
  "metricTransformations": []
}, context)

Input

input object
- filterName required FilterName
- filterPattern required FilterPattern
- logGroupName required LogGroupName
- metricTransformations required MetricTransformations

Output

Output schema unknown

PutResourcePolicy

amazonaws_logs.PutResourcePolicy({}, context)

Input

input object
- policyDocument PolicyDocument
- policyName PolicyName

Output

output PutResourcePolicyResponse

PutRetentionPolicy

amazonaws_logs.PutRetentionPolicy({
  "logGroupName": "",
  "retentionInDays": 0
}, context)

Input

input object
- logGroupName required LogGroupName
- retentionInDays required Days

Output

Output schema unknown

PutSubscriptionFilter

amazonaws_logs.PutSubscriptionFilter({
  "logGroupName": "",
  "filterName": "",
  "filterPattern": "",
  "destinationArn": ""
}, context)

Input

input object
- destinationArn required DestinationArn
- distribution Distribution
- filterName required FilterName
- filterPattern required FilterPattern
- logGroupName required LogGroupName
- roleArn RoleArn

Output

Output schema unknown

TagLogGroup

amazonaws_logs.TagLogGroup({
  "logGroupName": "",
  "tags": []
}, context)

Input

input object
- logGroupName required LogGroupName
- tags required Tags

Output

Output schema unknown

TestMetricFilter

amazonaws_logs.TestMetricFilter({
  "filterPattern": "",
  "logEventMessages": []
}, context)

Input

input object
- filterPattern required FilterPattern
- logEventMessages required TestEventMessages

Output

output TestMetricFilterResponse

UntagLogGroup

amazonaws_logs.UntagLogGroup({
  "logGroupName": "",
  "tags": []
}, context)

Input

input object
- logGroupName required LogGroupName
- tags required TagList

Output

Output schema unknown

Definitions

AccessPolicy

AccessPolicy string

Arn

Arn string

AssociateKmsKeyRequest

AssociateKmsKeyRequest object
- kmsKeyId required KmsKeyId
- logGroupName required LogGroupName

CancelExportTaskRequest

CancelExportTaskRequest object
- taskId required ExportTaskId

CreateExportTaskRequest

CreateExportTaskRequest object
- destination required ExportDestinationBucket
- destinationPrefix ExportDestinationPrefix
- from required Timestamp
- logGroupName required LogGroupName
- logStreamNamePrefix LogStreamName
- taskName ExportTaskName
- to required Timestamp

CreateExportTaskResponse

CreateExportTaskResponse object
- taskId ExportTaskId

CreateLogGroupRequest

CreateLogGroupRequest object
- kmsKeyId KmsKeyId
- logGroupName required LogGroupName
- tags Tags

CreateLogStreamRequest

CreateLogStreamRequest object
- logGroupName required LogGroupName
- logStreamName required LogStreamName

DataAlreadyAcceptedException

DataAlreadyAcceptedException object: The event was already logged.
- expectedSequenceToken SequenceToken

Days

Days integer: The number of days to retain the log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, and 3653.

DefaultValue

DefaultValue number

DeleteDestinationRequest

DeleteDestinationRequest object
- destinationName required DestinationName

DeleteLogGroupRequest

DeleteLogGroupRequest object
- logGroupName required LogGroupName

DeleteLogStreamRequest

DeleteLogStreamRequest object
- logGroupName required LogGroupName
- logStreamName required LogStreamName

DeleteMetricFilterRequest

DeleteMetricFilterRequest object
- filterName required FilterName
- logGroupName required LogGroupName

DeleteResourcePolicyRequest

DeleteResourcePolicyRequest object
- policyName PolicyName

DeleteRetentionPolicyRequest

DeleteRetentionPolicyRequest object
- logGroupName required LogGroupName

DeleteSubscriptionFilterRequest

DeleteSubscriptionFilterRequest object
- filterName required FilterName
- logGroupName required LogGroupName

Descending

Descending boolean

DescribeDestinationsRequest

DescribeDestinationsRequest object
- DestinationNamePrefix DestinationName
- limit DescribeLimit
- nextToken NextToken

DescribeDestinationsResponse

DescribeDestinationsResponse object
- destinations Destinations
- nextToken NextToken

DescribeExportTasksRequest

DescribeExportTasksRequest object
- limit DescribeLimit
- nextToken NextToken
- statusCode ExportTaskStatusCode
- taskId ExportTaskId

DescribeExportTasksResponse

DescribeExportTasksResponse object
- exportTasks ExportTasks
- nextToken NextToken

DescribeLimit

DescribeLimit integer

DescribeLogGroupsRequest

DescribeLogGroupsRequest object
- limit DescribeLimit
- logGroupNamePrefix LogGroupName
- nextToken NextToken

DescribeLogGroupsResponse

DescribeLogGroupsResponse object
- logGroups LogGroups
- nextToken NextToken

DescribeLogStreamsRequest

DescribeLogStreamsRequest object
- descending Descending
- limit DescribeLimit
- logGroupName required LogGroupName
- logStreamNamePrefix LogStreamName
- nextToken NextToken
- orderBy OrderBy

DescribeLogStreamsResponse

DescribeLogStreamsResponse object
- logStreams LogStreams
- nextToken NextToken

DescribeMetricFiltersRequest

DescribeMetricFiltersRequest object
- filterNamePrefix FilterName
- limit DescribeLimit
- logGroupName LogGroupName
- metricName MetricName
- metricNamespace MetricNamespace
- nextToken NextToken

DescribeMetricFiltersResponse

DescribeMetricFiltersResponse object
- metricFilters MetricFilters
- nextToken NextToken

DescribeResourcePoliciesRequest

DescribeResourcePoliciesRequest object
- limit DescribeLimit
- nextToken NextToken

DescribeResourcePoliciesResponse

DescribeResourcePoliciesResponse object
- nextToken NextToken
- resourcePolicies ResourcePolicies

DescribeSubscriptionFiltersRequest

DescribeSubscriptionFiltersRequest object
- filterNamePrefix FilterName
- limit DescribeLimit
- logGroupName required LogGroupName
- nextToken NextToken

DescribeSubscriptionFiltersResponse

DescribeSubscriptionFiltersResponse object
- nextToken NextToken
- subscriptionFilters SubscriptionFilters

Destination

Destination object: Represents a cross-account destination that receives subscription log events.
- accessPolicy AccessPolicy
- arn Arn
- creationTime Timestamp
- destinationName DestinationName
- roleArn RoleArn
- targetArn TargetArn

DestinationArn

DestinationArn string

DestinationName

DestinationName string

Destinations

Destinations array
- items Destination

DisassociateKmsKeyRequest

DisassociateKmsKeyRequest object
- logGroupName required LogGroupName

Distribution

Distribution string (values: Random, ByLogStream): The method used to distribute log data to the destination, which can be either random or grouped by log stream.

EventId

EventId string

EventMessage

EventMessage string

EventNumber

EventNumber integer

EventsLimit

EventsLimit integer

ExportDestinationBucket

ExportDestinationBucket string

ExportDestinationPrefix

ExportDestinationPrefix string

ExportTask

ExportTask object: Represents an export task.
- destination ExportDestinationBucket
- destinationPrefix ExportDestinationPrefix
- executionInfo ExportTaskExecutionInfo
- from Timestamp
- logGroupName LogGroupName
- status ExportTaskStatus
- taskId ExportTaskId
- taskName ExportTaskName
- to Timestamp

ExportTaskExecutionInfo

ExportTaskExecutionInfo object: Represents the status of an export task.
- completionTime Timestamp
- creationTime Timestamp

ExportTaskId

ExportTaskId string

ExportTaskName

ExportTaskName string

ExportTaskStatus

ExportTaskStatus object: Represents the status of an export task.
- code ExportTaskStatusCode
- message ExportTaskStatusMessage

ExportTaskStatusCode

ExportTaskStatusCode string (values: CANCELLED, COMPLETED, FAILED, PENDING, PENDING_CANCEL, RUNNING)

ExportTaskStatusMessage

ExportTaskStatusMessage string

ExportTasks

ExportTasks array
- items ExportTask

ExtractedValues

ExtractedValues array
- items object
  - key Token
  - value Value

FilterCount

FilterCount integer

FilterLogEventsRequest

FilterLogEventsRequest object
- endTime Timestamp
- filterPattern FilterPattern
- interleaved Interleaved
- limit EventsLimit
- logGroupName required LogGroupName
- logStreamNames InputLogStreamNames
- nextToken NextToken
- startTime Timestamp

FilterLogEventsResponse

FilterLogEventsResponse object
- events FilteredLogEvents
- nextToken NextToken
- searchedLogStreams SearchedLogStreams

FilterName

FilterName string

FilterPattern

FilterPattern string: A symbolic description of how CloudWatch Logs should interpret the data in each log event. For example, a log event may contain time stamps, IP addresses, strings, and so on. You use the filter pattern to specify what to look for in the log event message.

FilteredLogEvent

FilteredLogEvent object: Represents a matched event.
- eventId EventId
- ingestionTime Timestamp
- logStreamName LogStreamName
- message EventMessage
- timestamp Timestamp

FilteredLogEvents

FilteredLogEvents array
- items FilteredLogEvent

GetLogEventsRequest

GetLogEventsRequest object
- endTime Timestamp
- limit EventsLimit
- logGroupName required LogGroupName
- logStreamName required LogStreamName
- nextToken NextToken
- startFromHead StartFromHead
- startTime Timestamp

GetLogEventsResponse

GetLogEventsResponse object
- events OutputLogEvents
- nextBackwardToken NextToken
- nextForwardToken NextToken

InputLogEvent

InputLogEvent object: Represents a log event, which is a record of activity that was recorded by the application or resource being monitored.
- message required EventMessage
- timestamp required Timestamp

InputLogEvents

InputLogEvents array
- items InputLogEvent

InputLogStreamNames

InputLogStreamNames array
- items LogStreamName

Interleaved

Interleaved boolean

InvalidOperationException

InvalidOperationException object: The operation is not valid on the specified resource.

InvalidParameterException

InvalidParameterException object: A parameter is specified incorrectly.

InvalidSequenceTokenException

InvalidSequenceTokenException object: The sequence token is not valid.
- expectedSequenceToken SequenceToken

KmsKeyId

KmsKeyId string

LimitExceededException

LimitExceededException object: You have reached the maximum number of resources that can be created.

ListTagsLogGroupRequest

ListTagsLogGroupRequest object
- logGroupName required LogGroupName

ListTagsLogGroupResponse

ListTagsLogGroupResponse object
- tags Tags

LogEventIndex

LogEventIndex integer

LogGroup

LogGroup object: Represents a log group.
- arn Arn
- creationTime Timestamp
- kmsKeyId KmsKeyId
- logGroupName LogGroupName
- metricFilterCount FilterCount
- retentionInDays Days
- storedBytes StoredBytes

LogGroupName

LogGroupName string

LogGroups

LogGroups array
- items LogGroup

LogStream

LogStream object: Represents a log stream, which is a sequence of log events from a single emitter of logs.
- arn Arn
- creationTime Timestamp
- firstEventTimestamp Timestamp
- lastEventTimestamp Timestamp
- lastIngestionTime Timestamp
- logStreamName LogStreamName
- storedBytes StoredBytes
- uploadSequenceToken SequenceToken

LogStreamName

LogStreamName string

LogStreamSearchedCompletely

LogStreamSearchedCompletely boolean

LogStreams

LogStreams array
- items LogStream

MetricFilter

MetricFilter object: Metric filters express how CloudWatch Logs would extract metric observations from ingested log events and transform them into metric data in a CloudWatch metric.
- creationTime Timestamp
- filterName FilterName
- filterPattern FilterPattern
- logGroupName LogGroupName
- metricTransformations MetricTransformations

MetricFilterMatchRecord

MetricFilterMatchRecord object: Represents a matched event.
- eventMessage EventMessage
- eventNumber EventNumber
- extractedValues ExtractedValues

MetricFilterMatches

MetricFilterMatches array
- items MetricFilterMatchRecord

MetricFilters

MetricFilters array
- items MetricFilter

MetricName

MetricName string: The name of the CloudWatch metric to which the monitored log information should be published. For example, you may publish to a metric called ErrorCount.

MetricNamespace

MetricNamespace string

MetricTransformation

MetricTransformation object: Indicates how to transform ingested log events in to metric data in a CloudWatch metric.
- defaultValue DefaultValue
- metricName required MetricName
- metricNamespace required MetricNamespace
- metricValue required MetricValue

MetricTransformations

MetricTransformations array
- items MetricTransformation

MetricValue

MetricValue string: The value to publish to the CloudWatch metric. For example, if you're counting the occurrences of a term like "Error", the value is "1" for each occurrence. If you're counting the bytes transferred, the value is the value in the log event.

NextToken

NextToken string: The token for the next set of items to return. The token expires after 24 hours.

OperationAbortedException

OperationAbortedException object: Multiple requests to update the same resource were in conflict.

OrderBy

OrderBy string (values: LogStreamName, LastEventTime)

OutputLogEvent

OutputLogEvent object: Represents a log event.
- ingestionTime Timestamp
- message EventMessage
- timestamp Timestamp

OutputLogEvents

OutputLogEvents array
- items OutputLogEvent

PolicyDocument

PolicyDocument string

PolicyName

PolicyName string

PutDestinationPolicyRequest

PutDestinationPolicyRequest object
- accessPolicy required AccessPolicy
- destinationName required DestinationName

PutDestinationRequest

PutDestinationRequest object
- destinationName required DestinationName
- roleArn required RoleArn
- targetArn required TargetArn

PutDestinationResponse

PutDestinationResponse object
- destination Destination

PutLogEventsRequest

PutLogEventsRequest object
- logEvents required InputLogEvents
- logGroupName required LogGroupName
- logStreamName required LogStreamName
- sequenceToken SequenceToken

PutLogEventsResponse

PutLogEventsResponse object
- nextSequenceToken SequenceToken
- rejectedLogEventsInfo RejectedLogEventsInfo

PutMetricFilterRequest

PutMetricFilterRequest object
- filterName required FilterName
- filterPattern required FilterPattern
- logGroupName required LogGroupName
- metricTransformations required MetricTransformations

PutResourcePolicyRequest

PutResourcePolicyRequest object
- policyDocument PolicyDocument
- policyName PolicyName

PutResourcePolicyResponse

PutResourcePolicyResponse object
- resourcePolicy ResourcePolicy

PutRetentionPolicyRequest

PutRetentionPolicyRequest object
- logGroupName required LogGroupName
- retentionInDays required Days

PutSubscriptionFilterRequest

PutSubscriptionFilterRequest object
- destinationArn required DestinationArn
- distribution Distribution
- filterName required FilterName
- filterPattern required FilterPattern
- logGroupName required LogGroupName
- roleArn RoleArn

RejectedLogEventsInfo

RejectedLogEventsInfo object: Represents the rejected events.
- expiredLogEventEndIndex LogEventIndex
- tooNewLogEventStartIndex LogEventIndex
- tooOldLogEventEndIndex LogEventIndex

ResourceAlreadyExistsException

ResourceAlreadyExistsException object: The specified resource already exists.

ResourceNotFoundException

ResourceNotFoundException object: The specified resource does not exist.

ResourcePolicies

ResourcePolicies array
- items ResourcePolicy

ResourcePolicy

ResourcePolicy object: A policy enabling one or more entities to put logs to a log group in this account.
- lastUpdatedTime Timestamp
- policyDocument PolicyDocument
- policyName PolicyName

RoleArn

RoleArn string

SearchedLogStream

SearchedLogStream object: Represents the search status of a log stream.
- logStreamName LogStreamName
- searchedCompletely LogStreamSearchedCompletely

SearchedLogStreams

SearchedLogStreams array
- items SearchedLogStream

SequenceToken

SequenceToken string

ServiceUnavailableException

ServiceUnavailableException object: The service cannot complete the request.

StartFromHead

StartFromHead boolean

StoredBytes

StoredBytes integer

SubscriptionFilter

SubscriptionFilter object: Represents a subscription filter.
- creationTime Timestamp
- destinationArn DestinationArn
- distribution Distribution
- filterName FilterName
- filterPattern FilterPattern
- logGroupName LogGroupName
- roleArn RoleArn

SubscriptionFilters

SubscriptionFilters array
- items SubscriptionFilter

TagKey

TagKey string

TagList

TagList array
- items TagKey

TagLogGroupRequest

TagLogGroupRequest object
- logGroupName required LogGroupName
- tags required Tags

TagValue

TagValue string

TargetArn

TargetArn string

TestEventMessages

TestEventMessages array
- items EventMessage

TestMetricFilterRequest

TestMetricFilterRequest object
- filterPattern required FilterPattern
- logEventMessages required TestEventMessages

TestMetricFilterResponse

TestMetricFilterResponse object
- matches MetricFilterMatches

Timestamp

Timestamp integer

Token

Token string

UntagLogGroupRequest

UntagLogGroupRequest object
- logGroupName required LogGroupName
- tags required TagList

Value

Value string

datafire aws-sdk

@infinitebrahmanuniverse/nolb-_datafire_am @everything-registry/sub-chunk-220

5.0.0

7 years ago

4.0.0

8 years ago