Skip to content

Typed dictionaries#

Index > CloudWatchLogs > Typed dictionaries

Auto-generated documentation for CloudWatchLogs type annotations stubs module mypy-boto3-logs.

AssociateKmsKeyRequestRequestTypeDef#

# AssociateKmsKeyRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import AssociateKmsKeyRequestRequestTypeDef

def get_value() -> AssociateKmsKeyRequestRequestTypeDef:
    return {
        "logGroupName": ...,
        "kmsKeyId": ...,
    }
# AssociateKmsKeyRequestRequestTypeDef definition

class AssociateKmsKeyRequestRequestTypeDef(TypedDict):
    logGroupName: str,
    kmsKeyId: str,

CancelExportTaskRequestRequestTypeDef#

# CancelExportTaskRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import CancelExportTaskRequestRequestTypeDef

def get_value() -> CancelExportTaskRequestRequestTypeDef:
    return {
        "taskId": ...,
    }
# CancelExportTaskRequestRequestTypeDef definition

class CancelExportTaskRequestRequestTypeDef(TypedDict):
    taskId: str,

CreateExportTaskRequestRequestTypeDef#

# CreateExportTaskRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import CreateExportTaskRequestRequestTypeDef

def get_value() -> CreateExportTaskRequestRequestTypeDef:
    return {
        "logGroupName": ...,
        "fromTime": ...,
        "to": ...,
        "destination": ...,
    }
# CreateExportTaskRequestRequestTypeDef definition

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

CreateExportTaskResponseTypeDef#

# CreateExportTaskResponseTypeDef usage example

from mypy_boto3_logs.type_defs import CreateExportTaskResponseTypeDef

def get_value() -> CreateExportTaskResponseTypeDef:
    return {
        "taskId": ...,
        "ResponseMetadata": ...,
    }
# CreateExportTaskResponseTypeDef definition

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

CreateLogGroupRequestRequestTypeDef#

# CreateLogGroupRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import CreateLogGroupRequestRequestTypeDef

def get_value() -> CreateLogGroupRequestRequestTypeDef:
    return {
        "logGroupName": ...,
    }
# CreateLogGroupRequestRequestTypeDef definition

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

CreateLogStreamRequestRequestTypeDef#

# CreateLogStreamRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import CreateLogStreamRequestRequestTypeDef

def get_value() -> CreateLogStreamRequestRequestTypeDef:
    return {
        "logGroupName": ...,
        "logStreamName": ...,
    }
# CreateLogStreamRequestRequestTypeDef definition

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

DeleteDataProtectionPolicyRequestRequestTypeDef#

# DeleteDataProtectionPolicyRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import DeleteDataProtectionPolicyRequestRequestTypeDef

def get_value() -> DeleteDataProtectionPolicyRequestRequestTypeDef:
    return {
        "logGroupIdentifier": ...,
    }
# DeleteDataProtectionPolicyRequestRequestTypeDef definition

class DeleteDataProtectionPolicyRequestRequestTypeDef(TypedDict):
    logGroupIdentifier: str,

DeleteDestinationRequestRequestTypeDef#

# DeleteDestinationRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import DeleteDestinationRequestRequestTypeDef

def get_value() -> DeleteDestinationRequestRequestTypeDef:
    return {
        "destinationName": ...,
    }
# DeleteDestinationRequestRequestTypeDef definition

class DeleteDestinationRequestRequestTypeDef(TypedDict):
    destinationName: str,

DeleteLogGroupRequestRequestTypeDef#

# DeleteLogGroupRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import DeleteLogGroupRequestRequestTypeDef

def get_value() -> DeleteLogGroupRequestRequestTypeDef:
    return {
        "logGroupName": ...,
    }
# DeleteLogGroupRequestRequestTypeDef definition

class DeleteLogGroupRequestRequestTypeDef(TypedDict):
    logGroupName: str,

DeleteLogStreamRequestRequestTypeDef#

# DeleteLogStreamRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import DeleteLogStreamRequestRequestTypeDef

def get_value() -> DeleteLogStreamRequestRequestTypeDef:
    return {
        "logGroupName": ...,
        "logStreamName": ...,
    }
# DeleteLogStreamRequestRequestTypeDef definition

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

DeleteMetricFilterRequestRequestTypeDef#

# DeleteMetricFilterRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import DeleteMetricFilterRequestRequestTypeDef

def get_value() -> DeleteMetricFilterRequestRequestTypeDef:
    return {
        "logGroupName": ...,
        "filterName": ...,
    }
# DeleteMetricFilterRequestRequestTypeDef definition

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

DeleteQueryDefinitionRequestRequestTypeDef#

# DeleteQueryDefinitionRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import DeleteQueryDefinitionRequestRequestTypeDef

def get_value() -> DeleteQueryDefinitionRequestRequestTypeDef:
    return {
        "queryDefinitionId": ...,
    }
# DeleteQueryDefinitionRequestRequestTypeDef definition

class DeleteQueryDefinitionRequestRequestTypeDef(TypedDict):
    queryDefinitionId: str,

DeleteQueryDefinitionResponseTypeDef#

# DeleteQueryDefinitionResponseTypeDef usage example

from mypy_boto3_logs.type_defs import DeleteQueryDefinitionResponseTypeDef

def get_value() -> DeleteQueryDefinitionResponseTypeDef:
    return {
        "success": ...,
        "ResponseMetadata": ...,
    }
# DeleteQueryDefinitionResponseTypeDef definition

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

DeleteResourcePolicyRequestRequestTypeDef#

# DeleteResourcePolicyRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import DeleteResourcePolicyRequestRequestTypeDef

def get_value() -> DeleteResourcePolicyRequestRequestTypeDef:
    return {
        "policyName": ...,
    }
# DeleteResourcePolicyRequestRequestTypeDef definition

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

DeleteRetentionPolicyRequestRequestTypeDef#

# DeleteRetentionPolicyRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import DeleteRetentionPolicyRequestRequestTypeDef

def get_value() -> DeleteRetentionPolicyRequestRequestTypeDef:
    return {
        "logGroupName": ...,
    }
# DeleteRetentionPolicyRequestRequestTypeDef definition

class DeleteRetentionPolicyRequestRequestTypeDef(TypedDict):
    logGroupName: str,

DeleteSubscriptionFilterRequestRequestTypeDef#

# DeleteSubscriptionFilterRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import DeleteSubscriptionFilterRequestRequestTypeDef

def get_value() -> DeleteSubscriptionFilterRequestRequestTypeDef:
    return {
        "logGroupName": ...,
        "filterName": ...,
    }
# DeleteSubscriptionFilterRequestRequestTypeDef definition

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

DescribeDestinationsRequestDescribeDestinationsPaginateTypeDef#

# DescribeDestinationsRequestDescribeDestinationsPaginateTypeDef usage example

from mypy_boto3_logs.type_defs import DescribeDestinationsRequestDescribeDestinationsPaginateTypeDef

def get_value() -> DescribeDestinationsRequestDescribeDestinationsPaginateTypeDef:
    return {
        "DestinationNamePrefix": ...,
    }
# DescribeDestinationsRequestDescribeDestinationsPaginateTypeDef definition

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

DescribeDestinationsRequestRequestTypeDef#

# DescribeDestinationsRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import DescribeDestinationsRequestRequestTypeDef

def get_value() -> DescribeDestinationsRequestRequestTypeDef:
    return {
        "DestinationNamePrefix": ...,
    }
# DescribeDestinationsRequestRequestTypeDef definition

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

DestinationTypeDef#

# DestinationTypeDef usage example

from mypy_boto3_logs.type_defs import DestinationTypeDef

def get_value() -> DestinationTypeDef:
    return {
        "destinationName": ...,
    }
# DestinationTypeDef definition

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

DescribeExportTasksRequestDescribeExportTasksPaginateTypeDef#

# DescribeExportTasksRequestDescribeExportTasksPaginateTypeDef usage example

from mypy_boto3_logs.type_defs import DescribeExportTasksRequestDescribeExportTasksPaginateTypeDef

def get_value() -> DescribeExportTasksRequestDescribeExportTasksPaginateTypeDef:
    return {
        "taskId": ...,
    }
# DescribeExportTasksRequestDescribeExportTasksPaginateTypeDef definition

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

DescribeExportTasksRequestRequestTypeDef#

# DescribeExportTasksRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import DescribeExportTasksRequestRequestTypeDef

def get_value() -> DescribeExportTasksRequestRequestTypeDef:
    return {
        "taskId": ...,
    }
# DescribeExportTasksRequestRequestTypeDef definition

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

DescribeLogGroupsRequestDescribeLogGroupsPaginateTypeDef#

# DescribeLogGroupsRequestDescribeLogGroupsPaginateTypeDef usage example

from mypy_boto3_logs.type_defs import DescribeLogGroupsRequestDescribeLogGroupsPaginateTypeDef

def get_value() -> DescribeLogGroupsRequestDescribeLogGroupsPaginateTypeDef:
    return {
        "accountIdentifiers": ...,
    }
# 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

DescribeLogGroupsRequestRequestTypeDef#

# DescribeLogGroupsRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import DescribeLogGroupsRequestRequestTypeDef

def get_value() -> DescribeLogGroupsRequestRequestTypeDef:
    return {
        "accountIdentifiers": ...,
    }
# 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 usage example

from mypy_boto3_logs.type_defs import LogGroupTypeDef

def get_value() -> LogGroupTypeDef:
    return {
        "logGroupName": ...,
    }
# 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)
  1. See DataProtectionStatusType

DescribeLogStreamsRequestDescribeLogStreamsPaginateTypeDef#

# DescribeLogStreamsRequestDescribeLogStreamsPaginateTypeDef usage example

from mypy_boto3_logs.type_defs import DescribeLogStreamsRequestDescribeLogStreamsPaginateTypeDef

def get_value() -> DescribeLogStreamsRequestDescribeLogStreamsPaginateTypeDef:
    return {
        "logGroupName": ...,
    }
# 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

DescribeLogStreamsRequestRequestTypeDef#

# DescribeLogStreamsRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import DescribeLogStreamsRequestRequestTypeDef

def get_value() -> DescribeLogStreamsRequestRequestTypeDef:
    return {
        "logGroupName": ...,
    }
# 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 usage example

from mypy_boto3_logs.type_defs import LogStreamTypeDef

def get_value() -> LogStreamTypeDef:
    return {
        "logStreamName": ...,
    }
# 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],

DescribeMetricFiltersRequestDescribeMetricFiltersPaginateTypeDef#

# DescribeMetricFiltersRequestDescribeMetricFiltersPaginateTypeDef usage example

from mypy_boto3_logs.type_defs import DescribeMetricFiltersRequestDescribeMetricFiltersPaginateTypeDef

def get_value() -> DescribeMetricFiltersRequestDescribeMetricFiltersPaginateTypeDef:
    return {
        "logGroupName": ...,
    }
# DescribeMetricFiltersRequestDescribeMetricFiltersPaginateTypeDef definition

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

DescribeMetricFiltersRequestRequestTypeDef#

# DescribeMetricFiltersRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import DescribeMetricFiltersRequestRequestTypeDef

def get_value() -> DescribeMetricFiltersRequestRequestTypeDef:
    return {
        "logGroupName": ...,
    }
# DescribeMetricFiltersRequestRequestTypeDef definition

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

DescribeQueriesRequestDescribeQueriesPaginateTypeDef#

# DescribeQueriesRequestDescribeQueriesPaginateTypeDef usage example

from mypy_boto3_logs.type_defs import DescribeQueriesRequestDescribeQueriesPaginateTypeDef

def get_value() -> DescribeQueriesRequestDescribeQueriesPaginateTypeDef:
    return {
        "logGroupName": ...,
    }
# DescribeQueriesRequestDescribeQueriesPaginateTypeDef definition

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

DescribeQueriesRequestRequestTypeDef#

# DescribeQueriesRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import DescribeQueriesRequestRequestTypeDef

def get_value() -> DescribeQueriesRequestRequestTypeDef:
    return {
        "logGroupName": ...,
    }
# DescribeQueriesRequestRequestTypeDef definition

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

QueryInfoTypeDef#

# QueryInfoTypeDef usage example

from mypy_boto3_logs.type_defs import QueryInfoTypeDef

def get_value() -> QueryInfoTypeDef:
    return {
        "queryId": ...,
    }
# 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 usage example

from mypy_boto3_logs.type_defs import DescribeQueryDefinitionsRequestRequestTypeDef

def get_value() -> DescribeQueryDefinitionsRequestRequestTypeDef:
    return {
        "queryDefinitionNamePrefix": ...,
    }
# DescribeQueryDefinitionsRequestRequestTypeDef definition

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

QueryDefinitionTypeDef#

# QueryDefinitionTypeDef usage example

from mypy_boto3_logs.type_defs import QueryDefinitionTypeDef

def get_value() -> QueryDefinitionTypeDef:
    return {
        "queryDefinitionId": ...,
    }
# QueryDefinitionTypeDef definition

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

DescribeResourcePoliciesRequestDescribeResourcePoliciesPaginateTypeDef#

# DescribeResourcePoliciesRequestDescribeResourcePoliciesPaginateTypeDef usage example

from mypy_boto3_logs.type_defs import DescribeResourcePoliciesRequestDescribeResourcePoliciesPaginateTypeDef

def get_value() -> DescribeResourcePoliciesRequestDescribeResourcePoliciesPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }
# DescribeResourcePoliciesRequestDescribeResourcePoliciesPaginateTypeDef definition

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

DescribeResourcePoliciesRequestRequestTypeDef#

# DescribeResourcePoliciesRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import DescribeResourcePoliciesRequestRequestTypeDef

def get_value() -> DescribeResourcePoliciesRequestRequestTypeDef:
    return {
        "nextToken": ...,
    }
# DescribeResourcePoliciesRequestRequestTypeDef definition

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

ResourcePolicyTypeDef#

# ResourcePolicyTypeDef usage example

from mypy_boto3_logs.type_defs import ResourcePolicyTypeDef

def get_value() -> ResourcePolicyTypeDef:
    return {
        "policyName": ...,
    }
# ResourcePolicyTypeDef definition

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

DescribeSubscriptionFiltersRequestDescribeSubscriptionFiltersPaginateTypeDef#

# DescribeSubscriptionFiltersRequestDescribeSubscriptionFiltersPaginateTypeDef usage example

from mypy_boto3_logs.type_defs import DescribeSubscriptionFiltersRequestDescribeSubscriptionFiltersPaginateTypeDef

def get_value() -> DescribeSubscriptionFiltersRequestDescribeSubscriptionFiltersPaginateTypeDef:
    return {
        "logGroupName": ...,
    }
# DescribeSubscriptionFiltersRequestDescribeSubscriptionFiltersPaginateTypeDef definition

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

DescribeSubscriptionFiltersRequestRequestTypeDef#

# DescribeSubscriptionFiltersRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import DescribeSubscriptionFiltersRequestRequestTypeDef

def get_value() -> DescribeSubscriptionFiltersRequestRequestTypeDef:
    return {
        "logGroupName": ...,
    }
# DescribeSubscriptionFiltersRequestRequestTypeDef definition

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

SubscriptionFilterTypeDef#

# SubscriptionFilterTypeDef usage example

from mypy_boto3_logs.type_defs import SubscriptionFilterTypeDef

def get_value() -> SubscriptionFilterTypeDef:
    return {
        "filterName": ...,
    }
# 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 usage example

from mypy_boto3_logs.type_defs import DisassociateKmsKeyRequestRequestTypeDef

def get_value() -> DisassociateKmsKeyRequestRequestTypeDef:
    return {
        "logGroupName": ...,
    }
# DisassociateKmsKeyRequestRequestTypeDef definition

class DisassociateKmsKeyRequestRequestTypeDef(TypedDict):
    logGroupName: str,

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef usage example

from mypy_boto3_logs.type_defs import EmptyResponseMetadataTypeDef

def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }
# EmptyResponseMetadataTypeDef definition

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

ExportTaskExecutionInfoTypeDef#

# ExportTaskExecutionInfoTypeDef usage example

from mypy_boto3_logs.type_defs import ExportTaskExecutionInfoTypeDef

def get_value() -> ExportTaskExecutionInfoTypeDef:
    return {
        "creationTime": ...,
    }
# ExportTaskExecutionInfoTypeDef definition

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

ExportTaskStatusTypeDef#

# ExportTaskStatusTypeDef usage example

from mypy_boto3_logs.type_defs import ExportTaskStatusTypeDef

def get_value() -> ExportTaskStatusTypeDef:
    return {
        "code": ...,
    }
# ExportTaskStatusTypeDef definition

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

FilterLogEventsRequestFilterLogEventsPaginateTypeDef#

# FilterLogEventsRequestFilterLogEventsPaginateTypeDef usage example

from mypy_boto3_logs.type_defs import FilterLogEventsRequestFilterLogEventsPaginateTypeDef

def get_value() -> FilterLogEventsRequestFilterLogEventsPaginateTypeDef:
    return {
        "logGroupName": ...,
    }
# 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

FilterLogEventsRequestRequestTypeDef#

# FilterLogEventsRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import FilterLogEventsRequestRequestTypeDef

def get_value() -> FilterLogEventsRequestRequestTypeDef:
    return {
        "logGroupName": ...,
    }
# 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 usage example

from mypy_boto3_logs.type_defs import FilteredLogEventTypeDef

def get_value() -> FilteredLogEventTypeDef:
    return {
        "logStreamName": ...,
    }
# FilteredLogEventTypeDef definition

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

SearchedLogStreamTypeDef#

# SearchedLogStreamTypeDef usage example

from mypy_boto3_logs.type_defs import SearchedLogStreamTypeDef

def get_value() -> SearchedLogStreamTypeDef:
    return {
        "logStreamName": ...,
    }
# SearchedLogStreamTypeDef definition

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

GetDataProtectionPolicyRequestRequestTypeDef#

# GetDataProtectionPolicyRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import GetDataProtectionPolicyRequestRequestTypeDef

def get_value() -> GetDataProtectionPolicyRequestRequestTypeDef:
    return {
        "logGroupIdentifier": ...,
    }
# GetDataProtectionPolicyRequestRequestTypeDef definition

class GetDataProtectionPolicyRequestRequestTypeDef(TypedDict):
    logGroupIdentifier: str,

GetDataProtectionPolicyResponseTypeDef#

# GetDataProtectionPolicyResponseTypeDef usage example

from mypy_boto3_logs.type_defs import GetDataProtectionPolicyResponseTypeDef

def get_value() -> GetDataProtectionPolicyResponseTypeDef:
    return {
        "logGroupIdentifier": ...,
        "policyDocument": ...,
        "lastUpdatedTime": ...,
        "ResponseMetadata": ...,
    }
# GetDataProtectionPolicyResponseTypeDef definition

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

GetLogEventsRequestRequestTypeDef#

# GetLogEventsRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import GetLogEventsRequestRequestTypeDef

def get_value() -> GetLogEventsRequestRequestTypeDef:
    return {
        "logStreamName": ...,
    }
# 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 usage example

from mypy_boto3_logs.type_defs import OutputLogEventTypeDef

def get_value() -> OutputLogEventTypeDef:
    return {
        "timestamp": ...,
    }
# OutputLogEventTypeDef definition

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

GetLogGroupFieldsRequestRequestTypeDef#

# GetLogGroupFieldsRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import GetLogGroupFieldsRequestRequestTypeDef

def get_value() -> GetLogGroupFieldsRequestRequestTypeDef:
    return {
        "logGroupName": ...,
    }
# GetLogGroupFieldsRequestRequestTypeDef definition

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

LogGroupFieldTypeDef#

# LogGroupFieldTypeDef usage example

from mypy_boto3_logs.type_defs import LogGroupFieldTypeDef

def get_value() -> LogGroupFieldTypeDef:
    return {
        "name": ...,
    }
# LogGroupFieldTypeDef definition

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

GetLogRecordRequestRequestTypeDef#

# GetLogRecordRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import GetLogRecordRequestRequestTypeDef

def get_value() -> GetLogRecordRequestRequestTypeDef:
    return {
        "logRecordPointer": ...,
    }
# GetLogRecordRequestRequestTypeDef definition

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

GetLogRecordResponseTypeDef#

# GetLogRecordResponseTypeDef usage example

from mypy_boto3_logs.type_defs import GetLogRecordResponseTypeDef

def get_value() -> GetLogRecordResponseTypeDef:
    return {
        "logRecord": ...,
        "ResponseMetadata": ...,
    }
# GetLogRecordResponseTypeDef definition

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

GetQueryResultsRequestRequestTypeDef#

# GetQueryResultsRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import GetQueryResultsRequestRequestTypeDef

def get_value() -> GetQueryResultsRequestRequestTypeDef:
    return {
        "queryId": ...,
    }
# GetQueryResultsRequestRequestTypeDef definition

class GetQueryResultsRequestRequestTypeDef(TypedDict):
    queryId: str,

QueryStatisticsTypeDef#

# QueryStatisticsTypeDef usage example

from mypy_boto3_logs.type_defs import QueryStatisticsTypeDef

def get_value() -> QueryStatisticsTypeDef:
    return {
        "recordsMatched": ...,
    }
# QueryStatisticsTypeDef definition

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

ResultFieldTypeDef#

# ResultFieldTypeDef usage example

from mypy_boto3_logs.type_defs import ResultFieldTypeDef

def get_value() -> ResultFieldTypeDef:
    return {
        "field": ...,
    }
# ResultFieldTypeDef definition

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

InputLogEventTypeDef#

# InputLogEventTypeDef usage example

from mypy_boto3_logs.type_defs import InputLogEventTypeDef

def get_value() -> InputLogEventTypeDef:
    return {
        "timestamp": ...,
        "message": ...,
    }
# InputLogEventTypeDef definition

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

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import ListTagsForResourceRequestRequestTypeDef

def get_value() -> ListTagsForResourceRequestRequestTypeDef:
    return {
        "resourceArn": ...,
    }
# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef usage example

from mypy_boto3_logs.type_defs import ListTagsForResourceResponseTypeDef

def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "tags": ...,
        "ResponseMetadata": ...,
    }
# ListTagsForResourceResponseTypeDef definition

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

ListTagsLogGroupRequestRequestTypeDef#

# ListTagsLogGroupRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import ListTagsLogGroupRequestRequestTypeDef

def get_value() -> ListTagsLogGroupRequestRequestTypeDef:
    return {
        "logGroupName": ...,
    }
# ListTagsLogGroupRequestRequestTypeDef definition

class ListTagsLogGroupRequestRequestTypeDef(TypedDict):
    logGroupName: str,

ListTagsLogGroupResponseTypeDef#

# ListTagsLogGroupResponseTypeDef usage example

from mypy_boto3_logs.type_defs import ListTagsLogGroupResponseTypeDef

def get_value() -> ListTagsLogGroupResponseTypeDef:
    return {
        "tags": ...,
        "ResponseMetadata": ...,
    }
# ListTagsLogGroupResponseTypeDef definition

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

MetricFilterMatchRecordTypeDef#

# MetricFilterMatchRecordTypeDef usage example

from mypy_boto3_logs.type_defs import MetricFilterMatchRecordTypeDef

def get_value() -> MetricFilterMatchRecordTypeDef:
    return {
        "eventNumber": ...,
    }
# MetricFilterMatchRecordTypeDef definition

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

MetricTransformationTypeDef#

# MetricTransformationTypeDef usage example

from mypy_boto3_logs.type_defs import MetricTransformationTypeDef

def get_value() -> MetricTransformationTypeDef:
    return {
        "metricName": ...,
        "metricNamespace": ...,
        "metricValue": ...,
    }
# 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

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef usage example

from mypy_boto3_logs.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }
# PaginatorConfigTypeDef definition

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

PutDataProtectionPolicyRequestRequestTypeDef#

# PutDataProtectionPolicyRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import PutDataProtectionPolicyRequestRequestTypeDef

def get_value() -> PutDataProtectionPolicyRequestRequestTypeDef:
    return {
        "logGroupIdentifier": ...,
        "policyDocument": ...,
    }
# PutDataProtectionPolicyRequestRequestTypeDef definition

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

PutDataProtectionPolicyResponseTypeDef#

# PutDataProtectionPolicyResponseTypeDef usage example

from mypy_boto3_logs.type_defs import PutDataProtectionPolicyResponseTypeDef

def get_value() -> PutDataProtectionPolicyResponseTypeDef:
    return {
        "logGroupIdentifier": ...,
        "policyDocument": ...,
        "lastUpdatedTime": ...,
        "ResponseMetadata": ...,
    }
# PutDataProtectionPolicyResponseTypeDef definition

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

PutDestinationPolicyRequestRequestTypeDef#

# PutDestinationPolicyRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import PutDestinationPolicyRequestRequestTypeDef

def get_value() -> PutDestinationPolicyRequestRequestTypeDef:
    return {
        "destinationName": ...,
        "accessPolicy": ...,
    }
# PutDestinationPolicyRequestRequestTypeDef definition

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

PutDestinationRequestRequestTypeDef#

# PutDestinationRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import PutDestinationRequestRequestTypeDef

def get_value() -> PutDestinationRequestRequestTypeDef:
    return {
        "destinationName": ...,
        "targetArn": ...,
        "roleArn": ...,
    }
# PutDestinationRequestRequestTypeDef definition

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

RejectedLogEventsInfoTypeDef#

# RejectedLogEventsInfoTypeDef usage example

from mypy_boto3_logs.type_defs import RejectedLogEventsInfoTypeDef

def get_value() -> RejectedLogEventsInfoTypeDef:
    return {
        "tooNewLogEventStartIndex": ...,
    }
# RejectedLogEventsInfoTypeDef definition

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

PutQueryDefinitionRequestRequestTypeDef#

# PutQueryDefinitionRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import PutQueryDefinitionRequestRequestTypeDef

def get_value() -> PutQueryDefinitionRequestRequestTypeDef:
    return {
        "name": ...,
        "queryString": ...,
    }
# PutQueryDefinitionRequestRequestTypeDef definition

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

PutQueryDefinitionResponseTypeDef#

# PutQueryDefinitionResponseTypeDef usage example

from mypy_boto3_logs.type_defs import PutQueryDefinitionResponseTypeDef

def get_value() -> PutQueryDefinitionResponseTypeDef:
    return {
        "queryDefinitionId": ...,
        "ResponseMetadata": ...,
    }
# PutQueryDefinitionResponseTypeDef definition

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

PutResourcePolicyRequestRequestTypeDef#

# PutResourcePolicyRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import PutResourcePolicyRequestRequestTypeDef

def get_value() -> PutResourcePolicyRequestRequestTypeDef:
    return {
        "policyName": ...,
    }
# PutResourcePolicyRequestRequestTypeDef definition

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

PutRetentionPolicyRequestRequestTypeDef#

# PutRetentionPolicyRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import PutRetentionPolicyRequestRequestTypeDef

def get_value() -> PutRetentionPolicyRequestRequestTypeDef:
    return {
        "logGroupName": ...,
        "retentionInDays": ...,
    }
# PutRetentionPolicyRequestRequestTypeDef definition

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

PutSubscriptionFilterRequestRequestTypeDef#

# PutSubscriptionFilterRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import PutSubscriptionFilterRequestRequestTypeDef

def get_value() -> PutSubscriptionFilterRequestRequestTypeDef:
    return {
        "logGroupName": ...,
        "filterName": ...,
        "filterPattern": ...,
        "destinationArn": ...,
    }
# PutSubscriptionFilterRequestRequestTypeDef definition

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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef usage example

from mypy_boto3_logs.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
# ResponseMetadataTypeDef definition

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

StartQueryRequestRequestTypeDef#

# StartQueryRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import StartQueryRequestRequestTypeDef

def get_value() -> StartQueryRequestRequestTypeDef:
    return {
        "startTime": ...,
        "endTime": ...,
        "queryString": ...,
    }
# 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],

StartQueryResponseTypeDef#

# StartQueryResponseTypeDef usage example

from mypy_boto3_logs.type_defs import StartQueryResponseTypeDef

def get_value() -> StartQueryResponseTypeDef:
    return {
        "queryId": ...,
        "ResponseMetadata": ...,
    }
# StartQueryResponseTypeDef definition

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

StopQueryRequestRequestTypeDef#

# StopQueryRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import StopQueryRequestRequestTypeDef

def get_value() -> StopQueryRequestRequestTypeDef:
    return {
        "queryId": ...,
    }
# StopQueryRequestRequestTypeDef definition

class StopQueryRequestRequestTypeDef(TypedDict):
    queryId: str,

StopQueryResponseTypeDef#

# StopQueryResponseTypeDef usage example

from mypy_boto3_logs.type_defs import StopQueryResponseTypeDef

def get_value() -> StopQueryResponseTypeDef:
    return {
        "success": ...,
        "ResponseMetadata": ...,
    }
# StopQueryResponseTypeDef definition

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

TagLogGroupRequestRequestTypeDef#

# TagLogGroupRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import TagLogGroupRequestRequestTypeDef

def get_value() -> TagLogGroupRequestRequestTypeDef:
    return {
        "logGroupName": ...,
        "tags": ...,
    }
# TagLogGroupRequestRequestTypeDef definition

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

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import TagResourceRequestRequestTypeDef

def get_value() -> TagResourceRequestRequestTypeDef:
    return {
        "resourceArn": ...,
        "tags": ...,
    }
# TagResourceRequestRequestTypeDef definition

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

TestMetricFilterRequestRequestTypeDef#

# TestMetricFilterRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import TestMetricFilterRequestRequestTypeDef

def get_value() -> TestMetricFilterRequestRequestTypeDef:
    return {
        "filterPattern": ...,
        "logEventMessages": ...,
    }
# TestMetricFilterRequestRequestTypeDef definition

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

UntagLogGroupRequestRequestTypeDef#

# UntagLogGroupRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import UntagLogGroupRequestRequestTypeDef

def get_value() -> UntagLogGroupRequestRequestTypeDef:
    return {
        "logGroupName": ...,
        "tags": ...,
    }
# UntagLogGroupRequestRequestTypeDef definition

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

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import UntagResourceRequestRequestTypeDef

def get_value() -> UntagResourceRequestRequestTypeDef:
    return {
        "resourceArn": ...,
        "tagKeys": ...,
    }
# UntagResourceRequestRequestTypeDef definition

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

DescribeDestinationsResponseTypeDef#

# DescribeDestinationsResponseTypeDef usage example

from mypy_boto3_logs.type_defs import DescribeDestinationsResponseTypeDef

def get_value() -> DescribeDestinationsResponseTypeDef:
    return {
        "destinations": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }
# DescribeDestinationsResponseTypeDef definition

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

PutDestinationResponseTypeDef#

# PutDestinationResponseTypeDef usage example

from mypy_boto3_logs.type_defs import PutDestinationResponseTypeDef

def get_value() -> PutDestinationResponseTypeDef:
    return {
        "destination": ...,
        "ResponseMetadata": ...,
    }
# PutDestinationResponseTypeDef definition

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

DescribeLogGroupsResponseTypeDef#

# DescribeLogGroupsResponseTypeDef usage example

from mypy_boto3_logs.type_defs import DescribeLogGroupsResponseTypeDef

def get_value() -> DescribeLogGroupsResponseTypeDef:
    return {
        "logGroups": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }
# DescribeLogGroupsResponseTypeDef definition

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

DescribeLogStreamsResponseTypeDef#

# DescribeLogStreamsResponseTypeDef usage example

from mypy_boto3_logs.type_defs import DescribeLogStreamsResponseTypeDef

def get_value() -> DescribeLogStreamsResponseTypeDef:
    return {
        "logStreams": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }
# DescribeLogStreamsResponseTypeDef definition

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

DescribeQueriesResponseTypeDef#

# DescribeQueriesResponseTypeDef usage example

from mypy_boto3_logs.type_defs import DescribeQueriesResponseTypeDef

def get_value() -> DescribeQueriesResponseTypeDef:
    return {
        "queries": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }
# DescribeQueriesResponseTypeDef definition

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

DescribeQueryDefinitionsResponseTypeDef#

# DescribeQueryDefinitionsResponseTypeDef usage example

from mypy_boto3_logs.type_defs import DescribeQueryDefinitionsResponseTypeDef

def get_value() -> DescribeQueryDefinitionsResponseTypeDef:
    return {
        "queryDefinitions": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }
# DescribeQueryDefinitionsResponseTypeDef definition

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

DescribeResourcePoliciesResponseTypeDef#

# DescribeResourcePoliciesResponseTypeDef usage example

from mypy_boto3_logs.type_defs import DescribeResourcePoliciesResponseTypeDef

def get_value() -> DescribeResourcePoliciesResponseTypeDef:
    return {
        "resourcePolicies": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }
# DescribeResourcePoliciesResponseTypeDef definition

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

PutResourcePolicyResponseTypeDef#

# PutResourcePolicyResponseTypeDef usage example

from mypy_boto3_logs.type_defs import PutResourcePolicyResponseTypeDef

def get_value() -> PutResourcePolicyResponseTypeDef:
    return {
        "resourcePolicy": ...,
        "ResponseMetadata": ...,
    }
# PutResourcePolicyResponseTypeDef definition

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

DescribeSubscriptionFiltersResponseTypeDef#

# DescribeSubscriptionFiltersResponseTypeDef usage example

from mypy_boto3_logs.type_defs import DescribeSubscriptionFiltersResponseTypeDef

def get_value() -> DescribeSubscriptionFiltersResponseTypeDef:
    return {
        "subscriptionFilters": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }
# DescribeSubscriptionFiltersResponseTypeDef definition

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

ExportTaskTypeDef#

# ExportTaskTypeDef usage example

from mypy_boto3_logs.type_defs import ExportTaskTypeDef

def get_value() -> ExportTaskTypeDef:
    return {
        "taskId": ...,
    }
# 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 usage example

from mypy_boto3_logs.type_defs import FilterLogEventsResponseTypeDef

def get_value() -> FilterLogEventsResponseTypeDef:
    return {
        "events": ...,
        "searchedLogStreams": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }
# 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 usage example

from mypy_boto3_logs.type_defs import GetLogEventsResponseTypeDef

def get_value() -> GetLogEventsResponseTypeDef:
    return {
        "events": ...,
        "nextForwardToken": ...,
        "nextBackwardToken": ...,
        "ResponseMetadata": ...,
    }
# GetLogEventsResponseTypeDef definition

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

GetLogGroupFieldsResponseTypeDef#

# GetLogGroupFieldsResponseTypeDef usage example

from mypy_boto3_logs.type_defs import GetLogGroupFieldsResponseTypeDef

def get_value() -> GetLogGroupFieldsResponseTypeDef:
    return {
        "logGroupFields": ...,
        "ResponseMetadata": ...,
    }
# GetLogGroupFieldsResponseTypeDef definition

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

GetQueryResultsResponseTypeDef#

# GetQueryResultsResponseTypeDef usage example

from mypy_boto3_logs.type_defs import GetQueryResultsResponseTypeDef

def get_value() -> GetQueryResultsResponseTypeDef:
    return {
        "results": ...,
        "statistics": ...,
        "status": ...,
        "ResponseMetadata": ...,
    }
# GetQueryResultsResponseTypeDef definition

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

PutLogEventsRequestRequestTypeDef#

# PutLogEventsRequestRequestTypeDef usage example

from mypy_boto3_logs.type_defs import PutLogEventsRequestRequestTypeDef

def get_value() -> PutLogEventsRequestRequestTypeDef:
    return {
        "logGroupName": ...,
        "logStreamName": ...,
        "logEvents": ...,
    }
# PutLogEventsRequestRequestTypeDef definition

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

TestMetricFilterResponseTypeDef#

# TestMetricFilterResponseTypeDef usage example

from mypy_boto3_logs.type_defs import TestMetricFilterResponseTypeDef

def get_value() -> TestMetricFilterResponseTypeDef:
    return {
        "matches": ...,
        "ResponseMetadata": ...,
    }
# TestMetricFilterResponseTypeDef definition

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

MetricFilterTypeDef#

# MetricFilterTypeDef usage example

from mypy_boto3_logs.type_defs import MetricFilterTypeDef

def get_value() -> MetricFilterTypeDef:
    return {
        "filterName": ...,
    }
# 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 usage example

from mypy_boto3_logs.type_defs import PutMetricFilterRequestRequestTypeDef

def get_value() -> PutMetricFilterRequestRequestTypeDef:
    return {
        "logGroupName": ...,
        "filterName": ...,
        "filterPattern": ...,
        "metricTransformations": ...,
    }
# PutMetricFilterRequestRequestTypeDef definition

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

PutLogEventsResponseTypeDef#

# PutLogEventsResponseTypeDef usage example

from mypy_boto3_logs.type_defs import PutLogEventsResponseTypeDef

def get_value() -> PutLogEventsResponseTypeDef:
    return {
        "nextSequenceToken": ...,
        "rejectedLogEventsInfo": ...,
        "ResponseMetadata": ...,
    }
# PutLogEventsResponseTypeDef definition

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

DescribeExportTasksResponseTypeDef#

# DescribeExportTasksResponseTypeDef usage example

from mypy_boto3_logs.type_defs import DescribeExportTasksResponseTypeDef

def get_value() -> DescribeExportTasksResponseTypeDef:
    return {
        "exportTasks": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }
# DescribeExportTasksResponseTypeDef definition

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

DescribeMetricFiltersResponseTypeDef#

# DescribeMetricFiltersResponseTypeDef usage example

from mypy_boto3_logs.type_defs import DescribeMetricFiltersResponseTypeDef

def get_value() -> DescribeMetricFiltersResponseTypeDef:
    return {
        "metricFilters": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }
# DescribeMetricFiltersResponseTypeDef definition

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