Skip to content

Type definitions#

Index > CloudWatchLogs > Type definitions

Auto-generated documentation for CloudWatchLogs type annotations stubs module types-aiobotocore-logs.

AccountPolicyTypeDef#

# AccountPolicyTypeDef definition

class AccountPolicyTypeDef(TypedDict):
    policyName: NotRequired[str],
    policyDocument: NotRequired[str],
    lastUpdatedTime: NotRequired[int],
    policyType: NotRequired[PolicyTypeType],  # (1)
    scope: NotRequired[ScopeType],  # (2)
    accountId: NotRequired[str],
  1. See PolicyTypeType
  2. See ScopeType

AssociateKmsKeyRequestRequestTypeDef#

# AssociateKmsKeyRequestRequestTypeDef definition

class AssociateKmsKeyRequestRequestTypeDef(TypedDict):
    kmsKeyId: str,
    logGroupName: NotRequired[str],
    resourceIdentifier: NotRequired[str],

CancelExportTaskRequestRequestTypeDef#

# CancelExportTaskRequestRequestTypeDef definition

class CancelExportTaskRequestRequestTypeDef(TypedDict):
    taskId: str,

CreateExportTaskRequestRequestTypeDef#

# CreateExportTaskRequestRequestTypeDef definition

class CreateExportTaskRequestRequestTypeDef(TypedDict):
    logGroupName: str,
    fromTime: int,
    to: int,
    destination: str,
    taskName: NotRequired[str],
    logStreamNamePrefix: NotRequired[str],
    destinationPrefix: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

CreateLogGroupRequestRequestTypeDef#

# CreateLogGroupRequestRequestTypeDef definition

class CreateLogGroupRequestRequestTypeDef(TypedDict):
    logGroupName: str,
    kmsKeyId: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],

CreateLogStreamRequestRequestTypeDef#

# CreateLogStreamRequestRequestTypeDef definition

class CreateLogStreamRequestRequestTypeDef(TypedDict):
    logGroupName: str,
    logStreamName: str,

DeleteAccountPolicyRequestRequestTypeDef#

# DeleteAccountPolicyRequestRequestTypeDef definition

class DeleteAccountPolicyRequestRequestTypeDef(TypedDict):
    policyName: str,
    policyType: PolicyTypeType,  # (1)
  1. See PolicyTypeType

DeleteDataProtectionPolicyRequestRequestTypeDef#

# DeleteDataProtectionPolicyRequestRequestTypeDef definition

class DeleteDataProtectionPolicyRequestRequestTypeDef(TypedDict):
    logGroupIdentifier: str,

DeleteDestinationRequestRequestTypeDef#

# DeleteDestinationRequestRequestTypeDef definition

class DeleteDestinationRequestRequestTypeDef(TypedDict):
    destinationName: str,

DeleteLogGroupRequestRequestTypeDef#

# DeleteLogGroupRequestRequestTypeDef definition

class DeleteLogGroupRequestRequestTypeDef(TypedDict):
    logGroupName: str,

DeleteLogStreamRequestRequestTypeDef#

# DeleteLogStreamRequestRequestTypeDef definition

class DeleteLogStreamRequestRequestTypeDef(TypedDict):
    logGroupName: str,
    logStreamName: str,

DeleteMetricFilterRequestRequestTypeDef#

# DeleteMetricFilterRequestRequestTypeDef definition

class DeleteMetricFilterRequestRequestTypeDef(TypedDict):
    logGroupName: str,
    filterName: str,

DeleteQueryDefinitionRequestRequestTypeDef#

# DeleteQueryDefinitionRequestRequestTypeDef definition

class DeleteQueryDefinitionRequestRequestTypeDef(TypedDict):
    queryDefinitionId: str,

DeleteResourcePolicyRequestRequestTypeDef#

# DeleteResourcePolicyRequestRequestTypeDef definition

class DeleteResourcePolicyRequestRequestTypeDef(TypedDict):
    policyName: NotRequired[str],

DeleteRetentionPolicyRequestRequestTypeDef#

# DeleteRetentionPolicyRequestRequestTypeDef definition

class DeleteRetentionPolicyRequestRequestTypeDef(TypedDict):
    logGroupName: str,

DeleteSubscriptionFilterRequestRequestTypeDef#

# DeleteSubscriptionFilterRequestRequestTypeDef definition

class DeleteSubscriptionFilterRequestRequestTypeDef(TypedDict):
    logGroupName: str,
    filterName: str,

DescribeAccountPoliciesRequestRequestTypeDef#

# DescribeAccountPoliciesRequestRequestTypeDef definition

class DescribeAccountPoliciesRequestRequestTypeDef(TypedDict):
    policyType: PolicyTypeType,  # (1)
    policyName: NotRequired[str],
    accountIdentifiers: NotRequired[Sequence[str]],
  1. See PolicyTypeType

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

DescribeDestinationsRequestRequestTypeDef#

# DescribeDestinationsRequestRequestTypeDef definition

class DescribeDestinationsRequestRequestTypeDef(TypedDict):
    DestinationNamePrefix: NotRequired[str],
    nextToken: NotRequired[str],
    limit: NotRequired[int],

DestinationTypeDef#

# DestinationTypeDef definition

class DestinationTypeDef(TypedDict):
    destinationName: NotRequired[str],
    targetArn: NotRequired[str],
    roleArn: NotRequired[str],
    accessPolicy: NotRequired[str],
    arn: NotRequired[str],
    creationTime: NotRequired[int],

DescribeExportTasksRequestRequestTypeDef#

# DescribeExportTasksRequestRequestTypeDef definition

class DescribeExportTasksRequestRequestTypeDef(TypedDict):
    taskId: NotRequired[str],
    statusCode: NotRequired[ExportTaskStatusCodeType],  # (1)
    nextToken: NotRequired[str],
    limit: NotRequired[int],
  1. See ExportTaskStatusCodeType

DescribeLogGroupsRequestRequestTypeDef#

# DescribeLogGroupsRequestRequestTypeDef definition

class DescribeLogGroupsRequestRequestTypeDef(TypedDict):
    accountIdentifiers: NotRequired[Sequence[str]],
    logGroupNamePrefix: NotRequired[str],
    logGroupNamePattern: NotRequired[str],
    nextToken: NotRequired[str],
    limit: NotRequired[int],
    includeLinkedAccounts: NotRequired[bool],

LogGroupTypeDef#

# LogGroupTypeDef definition

class LogGroupTypeDef(TypedDict):
    logGroupName: NotRequired[str],
    creationTime: NotRequired[int],
    retentionInDays: NotRequired[int],
    metricFilterCount: NotRequired[int],
    arn: NotRequired[str],
    storedBytes: NotRequired[int],
    kmsKeyId: NotRequired[str],
    dataProtectionStatus: NotRequired[DataProtectionStatusType],  # (1)
    inheritedProperties: NotRequired[List[InheritedPropertyType]],  # (2)
  1. See DataProtectionStatusType
  2. See InheritedPropertyType

DescribeLogStreamsRequestRequestTypeDef#

# DescribeLogStreamsRequestRequestTypeDef definition

class DescribeLogStreamsRequestRequestTypeDef(TypedDict):
    logGroupName: NotRequired[str],
    logGroupIdentifier: NotRequired[str],
    logStreamNamePrefix: NotRequired[str],
    orderBy: NotRequired[OrderByType],  # (1)
    descending: NotRequired[bool],
    nextToken: NotRequired[str],
    limit: NotRequired[int],
  1. See OrderByType

LogStreamTypeDef#

# LogStreamTypeDef definition

class LogStreamTypeDef(TypedDict):
    logStreamName: NotRequired[str],
    creationTime: NotRequired[int],
    firstEventTimestamp: NotRequired[int],
    lastEventTimestamp: NotRequired[int],
    lastIngestionTime: NotRequired[int],
    uploadSequenceToken: NotRequired[str],
    arn: NotRequired[str],
    storedBytes: NotRequired[int],

DescribeMetricFiltersRequestRequestTypeDef#

# DescribeMetricFiltersRequestRequestTypeDef definition

class DescribeMetricFiltersRequestRequestTypeDef(TypedDict):
    logGroupName: NotRequired[str],
    filterNamePrefix: NotRequired[str],
    nextToken: NotRequired[str],
    limit: NotRequired[int],
    metricName: NotRequired[str],
    metricNamespace: NotRequired[str],

DescribeQueriesRequestRequestTypeDef#

# DescribeQueriesRequestRequestTypeDef definition

class DescribeQueriesRequestRequestTypeDef(TypedDict):
    logGroupName: NotRequired[str],
    status: NotRequired[QueryStatusType],  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
  1. See QueryStatusType

QueryInfoTypeDef#

# QueryInfoTypeDef definition

class QueryInfoTypeDef(TypedDict):
    queryId: NotRequired[str],
    queryString: NotRequired[str],
    status: NotRequired[QueryStatusType],  # (1)
    createTime: NotRequired[int],
    logGroupName: NotRequired[str],
  1. See QueryStatusType

DescribeQueryDefinitionsRequestRequestTypeDef#

# DescribeQueryDefinitionsRequestRequestTypeDef definition

class DescribeQueryDefinitionsRequestRequestTypeDef(TypedDict):
    queryDefinitionNamePrefix: NotRequired[str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

QueryDefinitionTypeDef#

# QueryDefinitionTypeDef definition

class QueryDefinitionTypeDef(TypedDict):
    queryDefinitionId: NotRequired[str],
    name: NotRequired[str],
    queryString: NotRequired[str],
    lastModified: NotRequired[int],
    logGroupNames: NotRequired[List[str]],

DescribeResourcePoliciesRequestRequestTypeDef#

# DescribeResourcePoliciesRequestRequestTypeDef definition

class DescribeResourcePoliciesRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    limit: NotRequired[int],

ResourcePolicyTypeDef#

# ResourcePolicyTypeDef definition

class ResourcePolicyTypeDef(TypedDict):
    policyName: NotRequired[str],
    policyDocument: NotRequired[str],
    lastUpdatedTime: NotRequired[int],

DescribeSubscriptionFiltersRequestRequestTypeDef#

# DescribeSubscriptionFiltersRequestRequestTypeDef definition

class DescribeSubscriptionFiltersRequestRequestTypeDef(TypedDict):
    logGroupName: str,
    filterNamePrefix: NotRequired[str],
    nextToken: NotRequired[str],
    limit: NotRequired[int],

SubscriptionFilterTypeDef#

# SubscriptionFilterTypeDef definition

class SubscriptionFilterTypeDef(TypedDict):
    filterName: NotRequired[str],
    logGroupName: NotRequired[str],
    filterPattern: NotRequired[str],
    destinationArn: NotRequired[str],
    roleArn: NotRequired[str],
    distribution: NotRequired[DistributionType],  # (1)
    creationTime: NotRequired[int],
  1. See DistributionType

DisassociateKmsKeyRequestRequestTypeDef#

# DisassociateKmsKeyRequestRequestTypeDef definition

class DisassociateKmsKeyRequestRequestTypeDef(TypedDict):
    logGroupName: NotRequired[str],
    resourceIdentifier: NotRequired[str],

ExportTaskExecutionInfoTypeDef#

# ExportTaskExecutionInfoTypeDef definition

class ExportTaskExecutionInfoTypeDef(TypedDict):
    creationTime: NotRequired[int],
    completionTime: NotRequired[int],

ExportTaskStatusTypeDef#

# ExportTaskStatusTypeDef definition

class ExportTaskStatusTypeDef(TypedDict):
    code: NotRequired[ExportTaskStatusCodeType],  # (1)
    message: NotRequired[str],
  1. See ExportTaskStatusCodeType

FilterLogEventsRequestRequestTypeDef#

# FilterLogEventsRequestRequestTypeDef definition

class FilterLogEventsRequestRequestTypeDef(TypedDict):
    logGroupName: NotRequired[str],
    logGroupIdentifier: NotRequired[str],
    logStreamNames: NotRequired[Sequence[str]],
    logStreamNamePrefix: NotRequired[str],
    startTime: NotRequired[int],
    endTime: NotRequired[int],
    filterPattern: NotRequired[str],
    nextToken: NotRequired[str],
    limit: NotRequired[int],
    interleaved: NotRequired[bool],
    unmask: NotRequired[bool],

FilteredLogEventTypeDef#

# FilteredLogEventTypeDef definition

class FilteredLogEventTypeDef(TypedDict):
    logStreamName: NotRequired[str],
    timestamp: NotRequired[int],
    message: NotRequired[str],
    ingestionTime: NotRequired[int],
    eventId: NotRequired[str],

SearchedLogStreamTypeDef#

# SearchedLogStreamTypeDef definition

class SearchedLogStreamTypeDef(TypedDict):
    logStreamName: NotRequired[str],
    searchedCompletely: NotRequired[bool],

GetDataProtectionPolicyRequestRequestTypeDef#

# GetDataProtectionPolicyRequestRequestTypeDef definition

class GetDataProtectionPolicyRequestRequestTypeDef(TypedDict):
    logGroupIdentifier: str,

GetLogEventsRequestRequestTypeDef#

# GetLogEventsRequestRequestTypeDef definition

class GetLogEventsRequestRequestTypeDef(TypedDict):
    logStreamName: str,
    logGroupName: NotRequired[str],
    logGroupIdentifier: NotRequired[str],
    startTime: NotRequired[int],
    endTime: NotRequired[int],
    nextToken: NotRequired[str],
    limit: NotRequired[int],
    startFromHead: NotRequired[bool],
    unmask: NotRequired[bool],

OutputLogEventTypeDef#

# OutputLogEventTypeDef definition

class OutputLogEventTypeDef(TypedDict):
    timestamp: NotRequired[int],
    message: NotRequired[str],
    ingestionTime: NotRequired[int],

GetLogGroupFieldsRequestRequestTypeDef#

# GetLogGroupFieldsRequestRequestTypeDef definition

class GetLogGroupFieldsRequestRequestTypeDef(TypedDict):
    logGroupName: NotRequired[str],
    time: NotRequired[int],
    logGroupIdentifier: NotRequired[str],

LogGroupFieldTypeDef#

# LogGroupFieldTypeDef definition

class LogGroupFieldTypeDef(TypedDict):
    name: NotRequired[str],
    percent: NotRequired[int],

GetLogRecordRequestRequestTypeDef#

# GetLogRecordRequestRequestTypeDef definition

class GetLogRecordRequestRequestTypeDef(TypedDict):
    logRecordPointer: str,
    unmask: NotRequired[bool],

GetQueryResultsRequestRequestTypeDef#

# GetQueryResultsRequestRequestTypeDef definition

class GetQueryResultsRequestRequestTypeDef(TypedDict):
    queryId: str,

QueryStatisticsTypeDef#

# QueryStatisticsTypeDef definition

class QueryStatisticsTypeDef(TypedDict):
    recordsMatched: NotRequired[float],
    recordsScanned: NotRequired[float],
    bytesScanned: NotRequired[float],

ResultFieldTypeDef#

# ResultFieldTypeDef definition

class ResultFieldTypeDef(TypedDict):
    field: NotRequired[str],
    value: NotRequired[str],

InputLogEventTypeDef#

# InputLogEventTypeDef definition

class InputLogEventTypeDef(TypedDict):
    timestamp: int,
    message: str,

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

ListTagsLogGroupRequestRequestTypeDef#

# ListTagsLogGroupRequestRequestTypeDef definition

class ListTagsLogGroupRequestRequestTypeDef(TypedDict):
    logGroupName: str,

MetricFilterMatchRecordTypeDef#

# MetricFilterMatchRecordTypeDef definition

class MetricFilterMatchRecordTypeDef(TypedDict):
    eventNumber: NotRequired[int],
    eventMessage: NotRequired[str],
    extractedValues: NotRequired[Dict[str, str]],

MetricTransformationTypeDef#

# MetricTransformationTypeDef definition

class MetricTransformationTypeDef(TypedDict):
    metricName: str,
    metricNamespace: str,
    metricValue: str,
    defaultValue: NotRequired[float],
    dimensions: NotRequired[Dict[str, str]],
    unit: NotRequired[StandardUnitType],  # (1)
  1. See StandardUnitType

PutAccountPolicyRequestRequestTypeDef#

# PutAccountPolicyRequestRequestTypeDef definition

class PutAccountPolicyRequestRequestTypeDef(TypedDict):
    policyName: str,
    policyDocument: str,
    policyType: PolicyTypeType,  # (1)
    scope: NotRequired[ScopeType],  # (2)
  1. See PolicyTypeType
  2. See ScopeType

PutDataProtectionPolicyRequestRequestTypeDef#

# PutDataProtectionPolicyRequestRequestTypeDef definition

class PutDataProtectionPolicyRequestRequestTypeDef(TypedDict):
    logGroupIdentifier: str,
    policyDocument: str,

PutDestinationPolicyRequestRequestTypeDef#

# PutDestinationPolicyRequestRequestTypeDef definition

class PutDestinationPolicyRequestRequestTypeDef(TypedDict):
    destinationName: str,
    accessPolicy: str,
    forceUpdate: NotRequired[bool],

PutDestinationRequestRequestTypeDef#

# PutDestinationRequestRequestTypeDef definition

class PutDestinationRequestRequestTypeDef(TypedDict):
    destinationName: str,
    targetArn: str,
    roleArn: str,
    tags: NotRequired[Mapping[str, str]],

RejectedLogEventsInfoTypeDef#

# RejectedLogEventsInfoTypeDef definition

class RejectedLogEventsInfoTypeDef(TypedDict):
    tooNewLogEventStartIndex: NotRequired[int],
    tooOldLogEventEndIndex: NotRequired[int],
    expiredLogEventEndIndex: NotRequired[int],

PutQueryDefinitionRequestRequestTypeDef#

# PutQueryDefinitionRequestRequestTypeDef definition

class PutQueryDefinitionRequestRequestTypeDef(TypedDict):
    name: str,
    queryString: str,
    queryDefinitionId: NotRequired[str],
    logGroupNames: NotRequired[Sequence[str]],

PutResourcePolicyRequestRequestTypeDef#

# PutResourcePolicyRequestRequestTypeDef definition

class PutResourcePolicyRequestRequestTypeDef(TypedDict):
    policyName: NotRequired[str],
    policyDocument: NotRequired[str],

PutRetentionPolicyRequestRequestTypeDef#

# PutRetentionPolicyRequestRequestTypeDef definition

class PutRetentionPolicyRequestRequestTypeDef(TypedDict):
    logGroupName: str,
    retentionInDays: int,

PutSubscriptionFilterRequestRequestTypeDef#

# PutSubscriptionFilterRequestRequestTypeDef definition

class PutSubscriptionFilterRequestRequestTypeDef(TypedDict):
    logGroupName: str,
    filterName: str,
    filterPattern: str,
    destinationArn: str,
    roleArn: NotRequired[str],
    distribution: NotRequired[DistributionType],  # (1)
  1. See DistributionType

StartQueryRequestRequestTypeDef#

# StartQueryRequestRequestTypeDef definition

class StartQueryRequestRequestTypeDef(TypedDict):
    startTime: int,
    endTime: int,
    queryString: str,
    logGroupName: NotRequired[str],
    logGroupNames: NotRequired[Sequence[str]],
    logGroupIdentifiers: NotRequired[Sequence[str]],
    limit: NotRequired[int],

StopQueryRequestRequestTypeDef#

# StopQueryRequestRequestTypeDef definition

class StopQueryRequestRequestTypeDef(TypedDict):
    queryId: str,

TagLogGroupRequestRequestTypeDef#

# TagLogGroupRequestRequestTypeDef definition

class TagLogGroupRequestRequestTypeDef(TypedDict):
    logGroupName: str,
    tags: Mapping[str, str],

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

TestMetricFilterRequestRequestTypeDef#

# TestMetricFilterRequestRequestTypeDef definition

class TestMetricFilterRequestRequestTypeDef(TypedDict):
    filterPattern: str,
    logEventMessages: Sequence[str],

UntagLogGroupRequestRequestTypeDef#

# UntagLogGroupRequestRequestTypeDef definition

class UntagLogGroupRequestRequestTypeDef(TypedDict):
    logGroupName: str,
    tags: Sequence[str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

CreateExportTaskResponseTypeDef#

# CreateExportTaskResponseTypeDef definition

class CreateExportTaskResponseTypeDef(TypedDict):
    taskId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteQueryDefinitionResponseTypeDef#

# DeleteQueryDefinitionResponseTypeDef definition

class DeleteQueryDefinitionResponseTypeDef(TypedDict):
    success: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeAccountPoliciesResponseTypeDef#

# DescribeAccountPoliciesResponseTypeDef definition

class DescribeAccountPoliciesResponseTypeDef(TypedDict):
    accountPolicies: List[AccountPolicyTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AccountPolicyTypeDef
  2. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetDataProtectionPolicyResponseTypeDef#

# GetDataProtectionPolicyResponseTypeDef definition

class GetDataProtectionPolicyResponseTypeDef(TypedDict):
    logGroupIdentifier: str,
    policyDocument: str,
    lastUpdatedTime: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetLogRecordResponseTypeDef#

# GetLogRecordResponseTypeDef definition

class GetLogRecordResponseTypeDef(TypedDict):
    logRecord: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsLogGroupResponseTypeDef#

# ListTagsLogGroupResponseTypeDef definition

class ListTagsLogGroupResponseTypeDef(TypedDict):
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PutAccountPolicyResponseTypeDef#

# PutAccountPolicyResponseTypeDef definition

class PutAccountPolicyResponseTypeDef(TypedDict):
    accountPolicy: AccountPolicyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AccountPolicyTypeDef
  2. See ResponseMetadataTypeDef

PutDataProtectionPolicyResponseTypeDef#

# PutDataProtectionPolicyResponseTypeDef definition

class PutDataProtectionPolicyResponseTypeDef(TypedDict):
    logGroupIdentifier: str,
    policyDocument: str,
    lastUpdatedTime: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PutQueryDefinitionResponseTypeDef#

# PutQueryDefinitionResponseTypeDef definition

class PutQueryDefinitionResponseTypeDef(TypedDict):
    queryDefinitionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartQueryResponseTypeDef#

# StartQueryResponseTypeDef definition

class StartQueryResponseTypeDef(TypedDict):
    queryId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StopQueryResponseTypeDef#

# StopQueryResponseTypeDef definition

class StopQueryResponseTypeDef(TypedDict):
    success: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeDestinationsRequestDescribeDestinationsPaginateTypeDef#

# DescribeDestinationsRequestDescribeDestinationsPaginateTypeDef definition

class DescribeDestinationsRequestDescribeDestinationsPaginateTypeDef(TypedDict):
    DestinationNamePrefix: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeExportTasksRequestDescribeExportTasksPaginateTypeDef#

# DescribeExportTasksRequestDescribeExportTasksPaginateTypeDef definition

class DescribeExportTasksRequestDescribeExportTasksPaginateTypeDef(TypedDict):
    taskId: NotRequired[str],
    statusCode: NotRequired[ExportTaskStatusCodeType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See ExportTaskStatusCodeType
  2. See PaginatorConfigTypeDef

DescribeLogGroupsRequestDescribeLogGroupsPaginateTypeDef#

# DescribeLogGroupsRequestDescribeLogGroupsPaginateTypeDef definition

class DescribeLogGroupsRequestDescribeLogGroupsPaginateTypeDef(TypedDict):
    accountIdentifiers: NotRequired[Sequence[str]],
    logGroupNamePrefix: NotRequired[str],
    logGroupNamePattern: NotRequired[str],
    includeLinkedAccounts: NotRequired[bool],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeLogStreamsRequestDescribeLogStreamsPaginateTypeDef#

# DescribeLogStreamsRequestDescribeLogStreamsPaginateTypeDef definition

class DescribeLogStreamsRequestDescribeLogStreamsPaginateTypeDef(TypedDict):
    logGroupName: NotRequired[str],
    logGroupIdentifier: NotRequired[str],
    logStreamNamePrefix: NotRequired[str],
    orderBy: NotRequired[OrderByType],  # (1)
    descending: NotRequired[bool],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See OrderByType
  2. See PaginatorConfigTypeDef

DescribeMetricFiltersRequestDescribeMetricFiltersPaginateTypeDef#

# DescribeMetricFiltersRequestDescribeMetricFiltersPaginateTypeDef definition

class DescribeMetricFiltersRequestDescribeMetricFiltersPaginateTypeDef(TypedDict):
    logGroupName: NotRequired[str],
    filterNamePrefix: NotRequired[str],
    metricName: NotRequired[str],
    metricNamespace: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeQueriesRequestDescribeQueriesPaginateTypeDef#

# DescribeQueriesRequestDescribeQueriesPaginateTypeDef definition

class DescribeQueriesRequestDescribeQueriesPaginateTypeDef(TypedDict):
    logGroupName: NotRequired[str],
    status: NotRequired[QueryStatusType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See QueryStatusType
  2. See PaginatorConfigTypeDef

DescribeResourcePoliciesRequestDescribeResourcePoliciesPaginateTypeDef#

# DescribeResourcePoliciesRequestDescribeResourcePoliciesPaginateTypeDef definition

class DescribeResourcePoliciesRequestDescribeResourcePoliciesPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeSubscriptionFiltersRequestDescribeSubscriptionFiltersPaginateTypeDef#

# DescribeSubscriptionFiltersRequestDescribeSubscriptionFiltersPaginateTypeDef definition

class DescribeSubscriptionFiltersRequestDescribeSubscriptionFiltersPaginateTypeDef(TypedDict):
    logGroupName: str,
    filterNamePrefix: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

FilterLogEventsRequestFilterLogEventsPaginateTypeDef#

# FilterLogEventsRequestFilterLogEventsPaginateTypeDef definition

class FilterLogEventsRequestFilterLogEventsPaginateTypeDef(TypedDict):
    logGroupName: NotRequired[str],
    logGroupIdentifier: NotRequired[str],
    logStreamNames: NotRequired[Sequence[str]],
    logStreamNamePrefix: NotRequired[str],
    startTime: NotRequired[int],
    endTime: NotRequired[int],
    filterPattern: NotRequired[str],
    interleaved: NotRequired[bool],
    unmask: NotRequired[bool],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeDestinationsResponseTypeDef#

# DescribeDestinationsResponseTypeDef definition

class DescribeDestinationsResponseTypeDef(TypedDict):
    destinations: List[DestinationTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DestinationTypeDef
  2. See ResponseMetadataTypeDef

PutDestinationResponseTypeDef#

# PutDestinationResponseTypeDef definition

class PutDestinationResponseTypeDef(TypedDict):
    destination: DestinationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DestinationTypeDef
  2. See ResponseMetadataTypeDef

DescribeLogGroupsResponseTypeDef#

# DescribeLogGroupsResponseTypeDef definition

class DescribeLogGroupsResponseTypeDef(TypedDict):
    logGroups: List[LogGroupTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See LogGroupTypeDef
  2. See ResponseMetadataTypeDef

DescribeLogStreamsResponseTypeDef#

# DescribeLogStreamsResponseTypeDef definition

class DescribeLogStreamsResponseTypeDef(TypedDict):
    logStreams: List[LogStreamTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See LogStreamTypeDef
  2. See ResponseMetadataTypeDef

DescribeQueriesResponseTypeDef#

# DescribeQueriesResponseTypeDef definition

class DescribeQueriesResponseTypeDef(TypedDict):
    queries: List[QueryInfoTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See QueryInfoTypeDef
  2. See ResponseMetadataTypeDef

DescribeQueryDefinitionsResponseTypeDef#

# DescribeQueryDefinitionsResponseTypeDef definition

class DescribeQueryDefinitionsResponseTypeDef(TypedDict):
    queryDefinitions: List[QueryDefinitionTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See QueryDefinitionTypeDef
  2. See ResponseMetadataTypeDef

DescribeResourcePoliciesResponseTypeDef#

# DescribeResourcePoliciesResponseTypeDef definition

class DescribeResourcePoliciesResponseTypeDef(TypedDict):
    resourcePolicies: List[ResourcePolicyTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ResourcePolicyTypeDef
  2. See ResponseMetadataTypeDef

PutResourcePolicyResponseTypeDef#

# PutResourcePolicyResponseTypeDef definition

class PutResourcePolicyResponseTypeDef(TypedDict):
    resourcePolicy: ResourcePolicyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ResourcePolicyTypeDef
  2. See ResponseMetadataTypeDef

DescribeSubscriptionFiltersResponseTypeDef#

# DescribeSubscriptionFiltersResponseTypeDef definition

class DescribeSubscriptionFiltersResponseTypeDef(TypedDict):
    subscriptionFilters: List[SubscriptionFilterTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SubscriptionFilterTypeDef
  2. See ResponseMetadataTypeDef

ExportTaskTypeDef#

# ExportTaskTypeDef definition

class ExportTaskTypeDef(TypedDict):
    taskId: NotRequired[str],
    taskName: NotRequired[str],
    logGroupName: NotRequired[str],
    from: NotRequired[int],
    to: NotRequired[int],
    destination: NotRequired[str],
    destinationPrefix: NotRequired[str],
    status: NotRequired[ExportTaskStatusTypeDef],  # (1)
    executionInfo: NotRequired[ExportTaskExecutionInfoTypeDef],  # (2)
  1. See ExportTaskStatusTypeDef
  2. See ExportTaskExecutionInfoTypeDef

FilterLogEventsResponseTypeDef#

# FilterLogEventsResponseTypeDef definition

class FilterLogEventsResponseTypeDef(TypedDict):
    events: List[FilteredLogEventTypeDef],  # (1)
    searchedLogStreams: List[SearchedLogStreamTypeDef],  # (2)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See FilteredLogEventTypeDef
  2. See SearchedLogStreamTypeDef
  3. See ResponseMetadataTypeDef

GetLogEventsResponseTypeDef#

# GetLogEventsResponseTypeDef definition

class GetLogEventsResponseTypeDef(TypedDict):
    events: List[OutputLogEventTypeDef],  # (1)
    nextForwardToken: str,
    nextBackwardToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See OutputLogEventTypeDef
  2. See ResponseMetadataTypeDef

GetLogGroupFieldsResponseTypeDef#

# GetLogGroupFieldsResponseTypeDef definition

class GetLogGroupFieldsResponseTypeDef(TypedDict):
    logGroupFields: List[LogGroupFieldTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See LogGroupFieldTypeDef
  2. See ResponseMetadataTypeDef

GetQueryResultsResponseTypeDef#

# GetQueryResultsResponseTypeDef definition

class GetQueryResultsResponseTypeDef(TypedDict):
    results: List[List[ResultFieldTypeDef]],  # (1)
    statistics: QueryStatisticsTypeDef,  # (2)
    status: QueryStatusType,  # (3)
    encryptionKey: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See ResultFieldTypeDef
  2. See QueryStatisticsTypeDef
  3. See QueryStatusType
  4. See ResponseMetadataTypeDef

PutLogEventsRequestRequestTypeDef#

# PutLogEventsRequestRequestTypeDef definition

class PutLogEventsRequestRequestTypeDef(TypedDict):
    logGroupName: str,
    logStreamName: str,
    logEvents: Sequence[InputLogEventTypeDef],  # (1)
    sequenceToken: NotRequired[str],
  1. See InputLogEventTypeDef

TestMetricFilterResponseTypeDef#

# TestMetricFilterResponseTypeDef definition

class TestMetricFilterResponseTypeDef(TypedDict):
    matches: List[MetricFilterMatchRecordTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MetricFilterMatchRecordTypeDef
  2. See ResponseMetadataTypeDef

MetricFilterTypeDef#

# MetricFilterTypeDef definition

class MetricFilterTypeDef(TypedDict):
    filterName: NotRequired[str],
    filterPattern: NotRequired[str],
    metricTransformations: NotRequired[List[MetricTransformationTypeDef]],  # (1)
    creationTime: NotRequired[int],
    logGroupName: NotRequired[str],
  1. See MetricTransformationTypeDef

PutMetricFilterRequestRequestTypeDef#

# PutMetricFilterRequestRequestTypeDef definition

class PutMetricFilterRequestRequestTypeDef(TypedDict):
    logGroupName: str,
    filterName: str,
    filterPattern: str,
    metricTransformations: Sequence[MetricTransformationTypeDef],  # (1)
  1. See MetricTransformationTypeDef

PutLogEventsResponseTypeDef#

# PutLogEventsResponseTypeDef definition

class PutLogEventsResponseTypeDef(TypedDict):
    nextSequenceToken: str,
    rejectedLogEventsInfo: RejectedLogEventsInfoTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RejectedLogEventsInfoTypeDef
  2. See ResponseMetadataTypeDef

DescribeExportTasksResponseTypeDef#

# DescribeExportTasksResponseTypeDef definition

class DescribeExportTasksResponseTypeDef(TypedDict):
    exportTasks: List[ExportTaskTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ExportTaskTypeDef
  2. See ResponseMetadataTypeDef

DescribeMetricFiltersResponseTypeDef#

# DescribeMetricFiltersResponseTypeDef definition

class DescribeMetricFiltersResponseTypeDef(TypedDict):
    metricFilters: List[MetricFilterTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MetricFilterTypeDef
  2. See ResponseMetadataTypeDef