Skip to content

Type definitions#

Index > CloudWatchLogs > Type definitions

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

CSVUnionTypeDef#

# CSVUnionTypeDef Union usage example

from types_boto3_logs.type_defs import CSVUnionTypeDef


def get_value() -> CSVUnionTypeDef:
    return ...


# CSVUnionTypeDef definition

CSVUnionTypeDef = Union[
    CSVTypeDef,  # (1)
    CSVOutputTypeDef,  # (2)
]
  1. See CSVTypeDef
  2. See CSVOutputTypeDef

DateTimeConverterUnionTypeDef#

# DateTimeConverterUnionTypeDef Union usage example

from types_boto3_logs.type_defs import DateTimeConverterUnionTypeDef


def get_value() -> DateTimeConverterUnionTypeDef:
    return ...


# DateTimeConverterUnionTypeDef definition

DateTimeConverterUnionTypeDef = Union[
    DateTimeConverterTypeDef,  # (1)
    DateTimeConverterOutputTypeDef,  # (2)
]
  1. See DateTimeConverterTypeDef
  2. See DateTimeConverterOutputTypeDef

DeleteKeysUnionTypeDef#

# DeleteKeysUnionTypeDef Union usage example

from types_boto3_logs.type_defs import DeleteKeysUnionTypeDef


def get_value() -> DeleteKeysUnionTypeDef:
    return ...


# DeleteKeysUnionTypeDef definition

DeleteKeysUnionTypeDef = Union[
    DeleteKeysTypeDef,  # (1)
    DeleteKeysOutputTypeDef,  # (2)
]
  1. See DeleteKeysTypeDef
  2. See DeleteKeysOutputTypeDef

LowerCaseStringUnionTypeDef#

# LowerCaseStringUnionTypeDef Union usage example

from types_boto3_logs.type_defs import LowerCaseStringUnionTypeDef


def get_value() -> LowerCaseStringUnionTypeDef:
    return ...


# LowerCaseStringUnionTypeDef definition

LowerCaseStringUnionTypeDef = Union[
    LowerCaseStringTypeDef,  # (1)
    LowerCaseStringOutputTypeDef,  # (2)
]
  1. See LowerCaseStringTypeDef
  2. See LowerCaseStringOutputTypeDef

MetricTransformationUnionTypeDef#

# MetricTransformationUnionTypeDef Union usage example

from types_boto3_logs.type_defs import MetricTransformationUnionTypeDef


def get_value() -> MetricTransformationUnionTypeDef:
    return ...


# MetricTransformationUnionTypeDef definition

MetricTransformationUnionTypeDef = Union[
    MetricTransformationTypeDef,  # (1)
    MetricTransformationOutputTypeDef,  # (2)
]
  1. See MetricTransformationTypeDef
  2. See MetricTransformationOutputTypeDef

TrimStringUnionTypeDef#

# TrimStringUnionTypeDef Union usage example

from types_boto3_logs.type_defs import TrimStringUnionTypeDef


def get_value() -> TrimStringUnionTypeDef:
    return ...


# TrimStringUnionTypeDef definition

TrimStringUnionTypeDef = Union[
    TrimStringTypeDef,  # (1)
    TrimStringOutputTypeDef,  # (2)
]
  1. See TrimStringTypeDef
  2. See TrimStringOutputTypeDef

UpperCaseStringUnionTypeDef#

# UpperCaseStringUnionTypeDef Union usage example

from types_boto3_logs.type_defs import UpperCaseStringUnionTypeDef


def get_value() -> UpperCaseStringUnionTypeDef:
    return ...


# UpperCaseStringUnionTypeDef definition

UpperCaseStringUnionTypeDef = Union[
    UpperCaseStringTypeDef,  # (1)
    UpperCaseStringOutputTypeDef,  # (2)
]
  1. See UpperCaseStringTypeDef
  2. See UpperCaseStringOutputTypeDef

AddKeysUnionTypeDef#

# AddKeysUnionTypeDef Union usage example

from types_boto3_logs.type_defs import AddKeysUnionTypeDef


def get_value() -> AddKeysUnionTypeDef:
    return ...


# AddKeysUnionTypeDef definition

AddKeysUnionTypeDef = Union[
    AddKeysTypeDef,  # (1)
    AddKeysOutputTypeDef,  # (2)
]
  1. See AddKeysTypeDef
  2. See AddKeysOutputTypeDef

CopyValueUnionTypeDef#

# CopyValueUnionTypeDef Union usage example

from types_boto3_logs.type_defs import CopyValueUnionTypeDef


def get_value() -> CopyValueUnionTypeDef:
    return ...


# CopyValueUnionTypeDef definition

CopyValueUnionTypeDef = Union[
    CopyValueTypeDef,  # (1)
    CopyValueOutputTypeDef,  # (2)
]
  1. See CopyValueTypeDef
  2. See CopyValueOutputTypeDef

MoveKeysUnionTypeDef#

# MoveKeysUnionTypeDef Union usage example

from types_boto3_logs.type_defs import MoveKeysUnionTypeDef


def get_value() -> MoveKeysUnionTypeDef:
    return ...


# MoveKeysUnionTypeDef definition

MoveKeysUnionTypeDef = Union[
    MoveKeysTypeDef,  # (1)
    MoveKeysOutputTypeDef,  # (2)
]
  1. See MoveKeysTypeDef
  2. See MoveKeysOutputTypeDef

RenameKeysUnionTypeDef#

# RenameKeysUnionTypeDef Union usage example

from types_boto3_logs.type_defs import RenameKeysUnionTypeDef


def get_value() -> RenameKeysUnionTypeDef:
    return ...


# RenameKeysUnionTypeDef definition

RenameKeysUnionTypeDef = Union[
    RenameKeysTypeDef,  # (1)
    RenameKeysOutputTypeDef,  # (2)
]
  1. See RenameKeysTypeDef
  2. See RenameKeysOutputTypeDef

SplitStringUnionTypeDef#

# SplitStringUnionTypeDef Union usage example

from types_boto3_logs.type_defs import SplitStringUnionTypeDef


def get_value() -> SplitStringUnionTypeDef:
    return ...


# SplitStringUnionTypeDef definition

SplitStringUnionTypeDef = Union[
    SplitStringTypeDef,  # (1)
    SplitStringOutputTypeDef,  # (2)
]
  1. See SplitStringTypeDef
  2. See SplitStringOutputTypeDef

SubstituteStringUnionTypeDef#

# SubstituteStringUnionTypeDef Union usage example

from types_boto3_logs.type_defs import SubstituteStringUnionTypeDef


def get_value() -> SubstituteStringUnionTypeDef:
    return ...


# SubstituteStringUnionTypeDef definition

SubstituteStringUnionTypeDef = Union[
    SubstituteStringTypeDef,  # (1)
    SubstituteStringOutputTypeDef,  # (2)
]
  1. See SubstituteStringTypeDef
  2. See SubstituteStringOutputTypeDef

TypeConverterUnionTypeDef#

# TypeConverterUnionTypeDef Union usage example

from types_boto3_logs.type_defs import TypeConverterUnionTypeDef


def get_value() -> TypeConverterUnionTypeDef:
    return ...


# TypeConverterUnionTypeDef definition

TypeConverterUnionTypeDef = Union[
    TypeConverterTypeDef,  # (1)
    TypeConverterOutputTypeDef,  # (2)
]
  1. See TypeConverterTypeDef
  2. See TypeConverterOutputTypeDef

ProcessorUnionTypeDef#

# ProcessorUnionTypeDef Union usage example

from types_boto3_logs.type_defs import ProcessorUnionTypeDef


def get_value() -> ProcessorUnionTypeDef:
    return ...


# ProcessorUnionTypeDef definition

ProcessorUnionTypeDef = Union[
    ProcessorTypeDef,  # (1)
    ProcessorOutputTypeDef,  # (2)
]
  1. See ProcessorTypeDef
  2. See ProcessorOutputTypeDef

AccountPolicyTypeDef#

# AccountPolicyTypeDef TypedDict usage example

from types_boto3_logs.type_defs import AccountPolicyTypeDef


def get_value() -> AccountPolicyTypeDef:
    return {
        "policyName": ...,
    }


# AccountPolicyTypeDef definition

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

AddKeyEntryTypeDef#

# AddKeyEntryTypeDef TypedDict usage example

from types_boto3_logs.type_defs import AddKeyEntryTypeDef


def get_value() -> AddKeyEntryTypeDef:
    return {
        "key": ...,
    }


# AddKeyEntryTypeDef definition

class AddKeyEntryTypeDef(TypedDict):
    key: str,
    value: str,
    overwriteIfExists: NotRequired[bool],

AnomalyDetectorTypeDef#

# AnomalyDetectorTypeDef TypedDict usage example

from types_boto3_logs.type_defs import AnomalyDetectorTypeDef


def get_value() -> AnomalyDetectorTypeDef:
    return {
        "anomalyDetectorArn": ...,
    }


# AnomalyDetectorTypeDef definition

class AnomalyDetectorTypeDef(TypedDict):
    anomalyDetectorArn: NotRequired[str],
    detectorName: NotRequired[str],
    logGroupArnList: NotRequired[List[str]],
    evaluationFrequency: NotRequired[EvaluationFrequencyType],  # (1)
    filterPattern: NotRequired[str],
    anomalyDetectorStatus: NotRequired[AnomalyDetectorStatusType],  # (2)
    kmsKeyId: NotRequired[str],
    creationTimeStamp: NotRequired[int],
    lastModifiedTimeStamp: NotRequired[int],
    anomalyVisibilityTime: NotRequired[int],
  1. See EvaluationFrequencyType
  2. See AnomalyDetectorStatusType

LogEventTypeDef#

# LogEventTypeDef TypedDict usage example

from types_boto3_logs.type_defs import LogEventTypeDef


def get_value() -> LogEventTypeDef:
    return {
        "timestamp": ...,
    }


# LogEventTypeDef definition

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

PatternTokenTypeDef#

# PatternTokenTypeDef TypedDict usage example

from types_boto3_logs.type_defs import PatternTokenTypeDef


def get_value() -> PatternTokenTypeDef:
    return {
        "dynamicTokenPosition": ...,
    }


# PatternTokenTypeDef definition

class PatternTokenTypeDef(TypedDict):
    dynamicTokenPosition: NotRequired[int],
    isDynamic: NotRequired[bool],
    tokenString: NotRequired[str],
    enumerations: NotRequired[Dict[str, int]],
    inferredTokenName: NotRequired[str],

AssociateKmsKeyRequestTypeDef#

# AssociateKmsKeyRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import AssociateKmsKeyRequestTypeDef


def get_value() -> AssociateKmsKeyRequestTypeDef:
    return {
        "kmsKeyId": ...,
    }


# AssociateKmsKeyRequestTypeDef definition

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

CSVOutputTypeDef#

# CSVOutputTypeDef TypedDict usage example

from types_boto3_logs.type_defs import CSVOutputTypeDef


def get_value() -> CSVOutputTypeDef:
    return {
        "quoteCharacter": ...,
    }


# CSVOutputTypeDef definition

class CSVOutputTypeDef(TypedDict):
    quoteCharacter: NotRequired[str],
    delimiter: NotRequired[str],
    columns: NotRequired[List[str]],
    source: NotRequired[str],

CSVTypeDef#

# CSVTypeDef TypedDict usage example

from types_boto3_logs.type_defs import CSVTypeDef


def get_value() -> CSVTypeDef:
    return {
        "quoteCharacter": ...,
    }


# CSVTypeDef definition

class CSVTypeDef(TypedDict):
    quoteCharacter: NotRequired[str],
    delimiter: NotRequired[str],
    columns: NotRequired[Sequence[str]],
    source: NotRequired[str],

CancelExportTaskRequestTypeDef#

# CancelExportTaskRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import CancelExportTaskRequestTypeDef


def get_value() -> CancelExportTaskRequestTypeDef:
    return {
        "taskId": ...,
    }


# CancelExportTaskRequestTypeDef definition

class CancelExportTaskRequestTypeDef(TypedDict):
    taskId: str,

S3DeliveryConfigurationTypeDef#

# S3DeliveryConfigurationTypeDef TypedDict usage example

from types_boto3_logs.type_defs import S3DeliveryConfigurationTypeDef


def get_value() -> S3DeliveryConfigurationTypeDef:
    return {
        "suffixPath": ...,
    }


# S3DeliveryConfigurationTypeDef definition

class S3DeliveryConfigurationTypeDef(TypedDict):
    suffixPath: NotRequired[str],
    enableHiveCompatiblePath: NotRequired[bool],

RecordFieldTypeDef#

# RecordFieldTypeDef TypedDict usage example

from types_boto3_logs.type_defs import RecordFieldTypeDef


def get_value() -> RecordFieldTypeDef:
    return {
        "name": ...,
    }


# RecordFieldTypeDef definition

class RecordFieldTypeDef(TypedDict):
    name: NotRequired[str],
    mandatory: NotRequired[bool],

CopyValueEntryTypeDef#

# CopyValueEntryTypeDef TypedDict usage example

from types_boto3_logs.type_defs import CopyValueEntryTypeDef


def get_value() -> CopyValueEntryTypeDef:
    return {
        "source": ...,
    }


# CopyValueEntryTypeDef definition

class CopyValueEntryTypeDef(TypedDict):
    source: str,
    target: str,
    overwriteIfExists: NotRequired[bool],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

from types_boto3_logs.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

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

CreateExportTaskRequestTypeDef#

# CreateExportTaskRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import CreateExportTaskRequestTypeDef


def get_value() -> CreateExportTaskRequestTypeDef:
    return {
        "logGroupName": ...,
    }


# CreateExportTaskRequestTypeDef definition

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

CreateLogAnomalyDetectorRequestTypeDef#

# CreateLogAnomalyDetectorRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import CreateLogAnomalyDetectorRequestTypeDef


def get_value() -> CreateLogAnomalyDetectorRequestTypeDef:
    return {
        "logGroupArnList": ...,
    }


# CreateLogAnomalyDetectorRequestTypeDef definition

class CreateLogAnomalyDetectorRequestTypeDef(TypedDict):
    logGroupArnList: Sequence[str],
    detectorName: NotRequired[str],
    evaluationFrequency: NotRequired[EvaluationFrequencyType],  # (1)
    filterPattern: NotRequired[str],
    kmsKeyId: NotRequired[str],
    anomalyVisibilityTime: NotRequired[int],
    tags: NotRequired[Mapping[str, str]],
  1. See EvaluationFrequencyType

CreateLogGroupRequestTypeDef#

# CreateLogGroupRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import CreateLogGroupRequestTypeDef


def get_value() -> CreateLogGroupRequestTypeDef:
    return {
        "logGroupName": ...,
    }


# CreateLogGroupRequestTypeDef definition

class CreateLogGroupRequestTypeDef(TypedDict):
    logGroupName: str,
    kmsKeyId: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
    logGroupClass: NotRequired[LogGroupClassType],  # (1)
  1. See LogGroupClassType

CreateLogStreamRequestTypeDef#

# CreateLogStreamRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import CreateLogStreamRequestTypeDef


def get_value() -> CreateLogStreamRequestTypeDef:
    return {
        "logGroupName": ...,
    }


# CreateLogStreamRequestTypeDef definition

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

DateTimeConverterOutputTypeDef#

# DateTimeConverterOutputTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DateTimeConverterOutputTypeDef


def get_value() -> DateTimeConverterOutputTypeDef:
    return {
        "source": ...,
    }


# DateTimeConverterOutputTypeDef definition

class DateTimeConverterOutputTypeDef(TypedDict):
    source: str,
    target: str,
    matchPatterns: List[str],
    targetFormat: NotRequired[str],
    sourceTimezone: NotRequired[str],
    targetTimezone: NotRequired[str],
    locale: NotRequired[str],

DateTimeConverterTypeDef#

# DateTimeConverterTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DateTimeConverterTypeDef


def get_value() -> DateTimeConverterTypeDef:
    return {
        "source": ...,
    }


# DateTimeConverterTypeDef definition

class DateTimeConverterTypeDef(TypedDict):
    source: str,
    target: str,
    matchPatterns: Sequence[str],
    targetFormat: NotRequired[str],
    sourceTimezone: NotRequired[str],
    targetTimezone: NotRequired[str],
    locale: NotRequired[str],

DeleteAccountPolicyRequestTypeDef#

# DeleteAccountPolicyRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DeleteAccountPolicyRequestTypeDef


def get_value() -> DeleteAccountPolicyRequestTypeDef:
    return {
        "policyName": ...,
    }


# DeleteAccountPolicyRequestTypeDef definition

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

DeleteDataProtectionPolicyRequestTypeDef#

# DeleteDataProtectionPolicyRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DeleteDataProtectionPolicyRequestTypeDef


def get_value() -> DeleteDataProtectionPolicyRequestTypeDef:
    return {
        "logGroupIdentifier": ...,
    }


# DeleteDataProtectionPolicyRequestTypeDef definition

class DeleteDataProtectionPolicyRequestTypeDef(TypedDict):
    logGroupIdentifier: str,

DeleteDeliveryDestinationPolicyRequestTypeDef#

# DeleteDeliveryDestinationPolicyRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DeleteDeliveryDestinationPolicyRequestTypeDef


def get_value() -> DeleteDeliveryDestinationPolicyRequestTypeDef:
    return {
        "deliveryDestinationName": ...,
    }


# DeleteDeliveryDestinationPolicyRequestTypeDef definition

class DeleteDeliveryDestinationPolicyRequestTypeDef(TypedDict):
    deliveryDestinationName: str,

DeleteDeliveryDestinationRequestTypeDef#

# DeleteDeliveryDestinationRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DeleteDeliveryDestinationRequestTypeDef


def get_value() -> DeleteDeliveryDestinationRequestTypeDef:
    return {
        "name": ...,
    }


# DeleteDeliveryDestinationRequestTypeDef definition

class DeleteDeliveryDestinationRequestTypeDef(TypedDict):
    name: str,

DeleteDeliveryRequestTypeDef#

# DeleteDeliveryRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DeleteDeliveryRequestTypeDef


def get_value() -> DeleteDeliveryRequestTypeDef:
    return {
        "id": ...,
    }


# DeleteDeliveryRequestTypeDef definition

class DeleteDeliveryRequestTypeDef(TypedDict):
    id: str,

DeleteDeliverySourceRequestTypeDef#

# DeleteDeliverySourceRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DeleteDeliverySourceRequestTypeDef


def get_value() -> DeleteDeliverySourceRequestTypeDef:
    return {
        "name": ...,
    }


# DeleteDeliverySourceRequestTypeDef definition

class DeleteDeliverySourceRequestTypeDef(TypedDict):
    name: str,

DeleteDestinationRequestTypeDef#

# DeleteDestinationRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DeleteDestinationRequestTypeDef


def get_value() -> DeleteDestinationRequestTypeDef:
    return {
        "destinationName": ...,
    }


# DeleteDestinationRequestTypeDef definition

class DeleteDestinationRequestTypeDef(TypedDict):
    destinationName: str,

DeleteIndexPolicyRequestTypeDef#

# DeleteIndexPolicyRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DeleteIndexPolicyRequestTypeDef


def get_value() -> DeleteIndexPolicyRequestTypeDef:
    return {
        "logGroupIdentifier": ...,
    }


# DeleteIndexPolicyRequestTypeDef definition

class DeleteIndexPolicyRequestTypeDef(TypedDict):
    logGroupIdentifier: str,

DeleteIntegrationRequestTypeDef#

# DeleteIntegrationRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DeleteIntegrationRequestTypeDef


def get_value() -> DeleteIntegrationRequestTypeDef:
    return {
        "integrationName": ...,
    }


# DeleteIntegrationRequestTypeDef definition

class DeleteIntegrationRequestTypeDef(TypedDict):
    integrationName: str,
    force: NotRequired[bool],

DeleteKeysOutputTypeDef#

# DeleteKeysOutputTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DeleteKeysOutputTypeDef


def get_value() -> DeleteKeysOutputTypeDef:
    return {
        "withKeys": ...,
    }


# DeleteKeysOutputTypeDef definition

class DeleteKeysOutputTypeDef(TypedDict):
    withKeys: List[str],

DeleteKeysTypeDef#

# DeleteKeysTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DeleteKeysTypeDef


def get_value() -> DeleteKeysTypeDef:
    return {
        "withKeys": ...,
    }


# DeleteKeysTypeDef definition

class DeleteKeysTypeDef(TypedDict):
    withKeys: Sequence[str],

DeleteLogAnomalyDetectorRequestTypeDef#

# DeleteLogAnomalyDetectorRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DeleteLogAnomalyDetectorRequestTypeDef


def get_value() -> DeleteLogAnomalyDetectorRequestTypeDef:
    return {
        "anomalyDetectorArn": ...,
    }


# DeleteLogAnomalyDetectorRequestTypeDef definition

class DeleteLogAnomalyDetectorRequestTypeDef(TypedDict):
    anomalyDetectorArn: str,

DeleteLogGroupRequestTypeDef#

# DeleteLogGroupRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DeleteLogGroupRequestTypeDef


def get_value() -> DeleteLogGroupRequestTypeDef:
    return {
        "logGroupName": ...,
    }


# DeleteLogGroupRequestTypeDef definition

class DeleteLogGroupRequestTypeDef(TypedDict):
    logGroupName: str,

DeleteLogStreamRequestTypeDef#

# DeleteLogStreamRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DeleteLogStreamRequestTypeDef


def get_value() -> DeleteLogStreamRequestTypeDef:
    return {
        "logGroupName": ...,
    }


# DeleteLogStreamRequestTypeDef definition

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

DeleteMetricFilterRequestTypeDef#

# DeleteMetricFilterRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DeleteMetricFilterRequestTypeDef


def get_value() -> DeleteMetricFilterRequestTypeDef:
    return {
        "logGroupName": ...,
    }


# DeleteMetricFilterRequestTypeDef definition

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

DeleteQueryDefinitionRequestTypeDef#

# DeleteQueryDefinitionRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DeleteQueryDefinitionRequestTypeDef


def get_value() -> DeleteQueryDefinitionRequestTypeDef:
    return {
        "queryDefinitionId": ...,
    }


# DeleteQueryDefinitionRequestTypeDef definition

class DeleteQueryDefinitionRequestTypeDef(TypedDict):
    queryDefinitionId: str,

DeleteResourcePolicyRequestTypeDef#

# DeleteResourcePolicyRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DeleteResourcePolicyRequestTypeDef


def get_value() -> DeleteResourcePolicyRequestTypeDef:
    return {
        "policyName": ...,
    }


# DeleteResourcePolicyRequestTypeDef definition

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

DeleteRetentionPolicyRequestTypeDef#

# DeleteRetentionPolicyRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DeleteRetentionPolicyRequestTypeDef


def get_value() -> DeleteRetentionPolicyRequestTypeDef:
    return {
        "logGroupName": ...,
    }


# DeleteRetentionPolicyRequestTypeDef definition

class DeleteRetentionPolicyRequestTypeDef(TypedDict):
    logGroupName: str,

DeleteSubscriptionFilterRequestTypeDef#

# DeleteSubscriptionFilterRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DeleteSubscriptionFilterRequestTypeDef


def get_value() -> DeleteSubscriptionFilterRequestTypeDef:
    return {
        "logGroupName": ...,
    }


# DeleteSubscriptionFilterRequestTypeDef definition

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

DeleteTransformerRequestTypeDef#

# DeleteTransformerRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DeleteTransformerRequestTypeDef


def get_value() -> DeleteTransformerRequestTypeDef:
    return {
        "logGroupIdentifier": ...,
    }


# DeleteTransformerRequestTypeDef definition

class DeleteTransformerRequestTypeDef(TypedDict):
    logGroupIdentifier: str,

DeliveryDestinationConfigurationTypeDef#

# DeliveryDestinationConfigurationTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DeliveryDestinationConfigurationTypeDef


def get_value() -> DeliveryDestinationConfigurationTypeDef:
    return {
        "destinationResourceArn": ...,
    }


# DeliveryDestinationConfigurationTypeDef definition

class DeliveryDestinationConfigurationTypeDef(TypedDict):
    destinationResourceArn: str,

DeliverySourceTypeDef#

# DeliverySourceTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DeliverySourceTypeDef


def get_value() -> DeliverySourceTypeDef:
    return {
        "name": ...,
    }


# DeliverySourceTypeDef definition

class DeliverySourceTypeDef(TypedDict):
    name: NotRequired[str],
    arn: NotRequired[str],
    resourceArns: NotRequired[List[str]],
    service: NotRequired[str],
    logType: NotRequired[str],
    tags: NotRequired[Dict[str, str]],

DescribeAccountPoliciesRequestTypeDef#

# DescribeAccountPoliciesRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeAccountPoliciesRequestTypeDef


def get_value() -> DescribeAccountPoliciesRequestTypeDef:
    return {
        "policyType": ...,
    }


# DescribeAccountPoliciesRequestTypeDef definition

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

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef TypedDict usage example

from types_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],

DescribeConfigurationTemplatesRequestTypeDef#

# DescribeConfigurationTemplatesRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeConfigurationTemplatesRequestTypeDef


def get_value() -> DescribeConfigurationTemplatesRequestTypeDef:
    return {
        "service": ...,
    }


# DescribeConfigurationTemplatesRequestTypeDef definition

class DescribeConfigurationTemplatesRequestTypeDef(TypedDict):
    service: NotRequired[str],
    logTypes: NotRequired[Sequence[str]],
    resourceTypes: NotRequired[Sequence[str]],
    deliveryDestinationTypes: NotRequired[Sequence[DeliveryDestinationTypeType]],  # (1)
    nextToken: NotRequired[str],
    limit: NotRequired[int],
  1. See DeliveryDestinationTypeType

DescribeDeliveriesRequestTypeDef#

# DescribeDeliveriesRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeDeliveriesRequestTypeDef


def get_value() -> DescribeDeliveriesRequestTypeDef:
    return {
        "nextToken": ...,
    }


# DescribeDeliveriesRequestTypeDef definition

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

DescribeDeliveryDestinationsRequestTypeDef#

# DescribeDeliveryDestinationsRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeDeliveryDestinationsRequestTypeDef


def get_value() -> DescribeDeliveryDestinationsRequestTypeDef:
    return {
        "nextToken": ...,
    }


# DescribeDeliveryDestinationsRequestTypeDef definition

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

DescribeDeliverySourcesRequestTypeDef#

# DescribeDeliverySourcesRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeDeliverySourcesRequestTypeDef


def get_value() -> DescribeDeliverySourcesRequestTypeDef:
    return {
        "nextToken": ...,
    }


# DescribeDeliverySourcesRequestTypeDef definition

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

DescribeDestinationsRequestTypeDef#

# DescribeDestinationsRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeDestinationsRequestTypeDef


def get_value() -> DescribeDestinationsRequestTypeDef:
    return {
        "DestinationNamePrefix": ...,
    }


# DescribeDestinationsRequestTypeDef definition

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

DestinationTypeDef#

# DestinationTypeDef TypedDict usage example

from types_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],

DescribeExportTasksRequestTypeDef#

# DescribeExportTasksRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeExportTasksRequestTypeDef


def get_value() -> DescribeExportTasksRequestTypeDef:
    return {
        "taskId": ...,
    }


# DescribeExportTasksRequestTypeDef definition

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

DescribeFieldIndexesRequestTypeDef#

# DescribeFieldIndexesRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeFieldIndexesRequestTypeDef


def get_value() -> DescribeFieldIndexesRequestTypeDef:
    return {
        "logGroupIdentifiers": ...,
    }


# DescribeFieldIndexesRequestTypeDef definition

class DescribeFieldIndexesRequestTypeDef(TypedDict):
    logGroupIdentifiers: Sequence[str],
    nextToken: NotRequired[str],

FieldIndexTypeDef#

# FieldIndexTypeDef TypedDict usage example

from types_boto3_logs.type_defs import FieldIndexTypeDef


def get_value() -> FieldIndexTypeDef:
    return {
        "logGroupIdentifier": ...,
    }


# FieldIndexTypeDef definition

class FieldIndexTypeDef(TypedDict):
    logGroupIdentifier: NotRequired[str],
    fieldIndexName: NotRequired[str],
    lastScanTime: NotRequired[int],
    firstEventTime: NotRequired[int],
    lastEventTime: NotRequired[int],

DescribeIndexPoliciesRequestTypeDef#

# DescribeIndexPoliciesRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeIndexPoliciesRequestTypeDef


def get_value() -> DescribeIndexPoliciesRequestTypeDef:
    return {
        "logGroupIdentifiers": ...,
    }


# DescribeIndexPoliciesRequestTypeDef definition

class DescribeIndexPoliciesRequestTypeDef(TypedDict):
    logGroupIdentifiers: Sequence[str],
    nextToken: NotRequired[str],

IndexPolicyTypeDef#

# IndexPolicyTypeDef TypedDict usage example

from types_boto3_logs.type_defs import IndexPolicyTypeDef


def get_value() -> IndexPolicyTypeDef:
    return {
        "logGroupIdentifier": ...,
    }


# IndexPolicyTypeDef definition

class IndexPolicyTypeDef(TypedDict):
    logGroupIdentifier: NotRequired[str],
    lastUpdateTime: NotRequired[int],
    policyDocument: NotRequired[str],
    policyName: NotRequired[str],
    source: NotRequired[IndexSourceType],  # (1)
  1. See IndexSourceType

DescribeLogGroupsRequestTypeDef#

# DescribeLogGroupsRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeLogGroupsRequestTypeDef


def get_value() -> DescribeLogGroupsRequestTypeDef:
    return {
        "accountIdentifiers": ...,
    }


# DescribeLogGroupsRequestTypeDef definition

class DescribeLogGroupsRequestTypeDef(TypedDict):
    accountIdentifiers: NotRequired[Sequence[str]],
    logGroupNamePrefix: NotRequired[str],
    logGroupNamePattern: NotRequired[str],
    nextToken: NotRequired[str],
    limit: NotRequired[int],
    includeLinkedAccounts: NotRequired[bool],
    logGroupClass: NotRequired[LogGroupClassType],  # (1)
  1. See LogGroupClassType

LogGroupTypeDef#

# LogGroupTypeDef TypedDict usage example

from types_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)
    inheritedProperties: NotRequired[List[InheritedPropertyType]],  # (2)
    logGroupClass: NotRequired[LogGroupClassType],  # (3)
    logGroupArn: NotRequired[str],
  1. See DataProtectionStatusType
  2. See InheritedPropertyType
  3. See LogGroupClassType

DescribeLogStreamsRequestTypeDef#

# DescribeLogStreamsRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeLogStreamsRequestTypeDef


def get_value() -> DescribeLogStreamsRequestTypeDef:
    return {
        "logGroupName": ...,
    }


# DescribeLogStreamsRequestTypeDef definition

class DescribeLogStreamsRequestTypeDef(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 TypedDict usage example

from types_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],

DescribeMetricFiltersRequestTypeDef#

# DescribeMetricFiltersRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeMetricFiltersRequestTypeDef


def get_value() -> DescribeMetricFiltersRequestTypeDef:
    return {
        "logGroupName": ...,
    }


# DescribeMetricFiltersRequestTypeDef definition

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

DescribeQueriesRequestTypeDef#

# DescribeQueriesRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeQueriesRequestTypeDef


def get_value() -> DescribeQueriesRequestTypeDef:
    return {
        "logGroupName": ...,
    }


# DescribeQueriesRequestTypeDef definition

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

QueryInfoTypeDef#

# QueryInfoTypeDef TypedDict usage example

from types_boto3_logs.type_defs import QueryInfoTypeDef


def get_value() -> QueryInfoTypeDef:
    return {
        "queryLanguage": ...,
    }


# QueryInfoTypeDef definition

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

DescribeQueryDefinitionsRequestTypeDef#

# DescribeQueryDefinitionsRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeQueryDefinitionsRequestTypeDef


def get_value() -> DescribeQueryDefinitionsRequestTypeDef:
    return {
        "queryLanguage": ...,
    }


# DescribeQueryDefinitionsRequestTypeDef definition

class DescribeQueryDefinitionsRequestTypeDef(TypedDict):
    queryLanguage: NotRequired[QueryLanguageType],  # (1)
    queryDefinitionNamePrefix: NotRequired[str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
  1. See QueryLanguageType

QueryDefinitionTypeDef#

# QueryDefinitionTypeDef TypedDict usage example

from types_boto3_logs.type_defs import QueryDefinitionTypeDef


def get_value() -> QueryDefinitionTypeDef:
    return {
        "queryLanguage": ...,
    }


# QueryDefinitionTypeDef definition

class QueryDefinitionTypeDef(TypedDict):
    queryLanguage: NotRequired[QueryLanguageType],  # (1)
    queryDefinitionId: NotRequired[str],
    name: NotRequired[str],
    queryString: NotRequired[str],
    lastModified: NotRequired[int],
    logGroupNames: NotRequired[List[str]],
  1. See QueryLanguageType

DescribeResourcePoliciesRequestTypeDef#

# DescribeResourcePoliciesRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeResourcePoliciesRequestTypeDef


def get_value() -> DescribeResourcePoliciesRequestTypeDef:
    return {
        "nextToken": ...,
    }


# DescribeResourcePoliciesRequestTypeDef definition

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

ResourcePolicyTypeDef#

# ResourcePolicyTypeDef TypedDict usage example

from types_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],

DescribeSubscriptionFiltersRequestTypeDef#

# DescribeSubscriptionFiltersRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeSubscriptionFiltersRequestTypeDef


def get_value() -> DescribeSubscriptionFiltersRequestTypeDef:
    return {
        "logGroupName": ...,
    }


# DescribeSubscriptionFiltersRequestTypeDef definition

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

SubscriptionFilterTypeDef#

# SubscriptionFilterTypeDef TypedDict usage example

from types_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)
    applyOnTransformedLogs: NotRequired[bool],
    creationTime: NotRequired[int],
  1. See DistributionType

DisassociateKmsKeyRequestTypeDef#

# DisassociateKmsKeyRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DisassociateKmsKeyRequestTypeDef


def get_value() -> DisassociateKmsKeyRequestTypeDef:
    return {
        "logGroupName": ...,
    }


# DisassociateKmsKeyRequestTypeDef definition

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

EntityTypeDef#

# EntityTypeDef TypedDict usage example

from types_boto3_logs.type_defs import EntityTypeDef


def get_value() -> EntityTypeDef:
    return {
        "keyAttributes": ...,
    }


# EntityTypeDef definition

class EntityTypeDef(TypedDict):
    keyAttributes: NotRequired[Mapping[str, str]],
    attributes: NotRequired[Mapping[str, str]],

ExportTaskExecutionInfoTypeDef#

# ExportTaskExecutionInfoTypeDef TypedDict usage example

from types_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 TypedDict usage example

from types_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

FilterLogEventsRequestTypeDef#

# FilterLogEventsRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import FilterLogEventsRequestTypeDef


def get_value() -> FilterLogEventsRequestTypeDef:
    return {
        "logGroupName": ...,
    }


# FilterLogEventsRequestTypeDef definition

class FilterLogEventsRequestTypeDef(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 TypedDict usage example

from types_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 TypedDict usage example

from types_boto3_logs.type_defs import SearchedLogStreamTypeDef


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


# SearchedLogStreamTypeDef definition

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

GetDataProtectionPolicyRequestTypeDef#

# GetDataProtectionPolicyRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import GetDataProtectionPolicyRequestTypeDef


def get_value() -> GetDataProtectionPolicyRequestTypeDef:
    return {
        "logGroupIdentifier": ...,
    }


# GetDataProtectionPolicyRequestTypeDef definition

class GetDataProtectionPolicyRequestTypeDef(TypedDict):
    logGroupIdentifier: str,

GetDeliveryDestinationPolicyRequestTypeDef#

# GetDeliveryDestinationPolicyRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import GetDeliveryDestinationPolicyRequestTypeDef


def get_value() -> GetDeliveryDestinationPolicyRequestTypeDef:
    return {
        "deliveryDestinationName": ...,
    }


# GetDeliveryDestinationPolicyRequestTypeDef definition

class GetDeliveryDestinationPolicyRequestTypeDef(TypedDict):
    deliveryDestinationName: str,

PolicyTypeDef#

# PolicyTypeDef TypedDict usage example

from types_boto3_logs.type_defs import PolicyTypeDef


def get_value() -> PolicyTypeDef:
    return {
        "deliveryDestinationPolicy": ...,
    }


# PolicyTypeDef definition

class PolicyTypeDef(TypedDict):
    deliveryDestinationPolicy: NotRequired[str],

GetDeliveryDestinationRequestTypeDef#

# GetDeliveryDestinationRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import GetDeliveryDestinationRequestTypeDef


def get_value() -> GetDeliveryDestinationRequestTypeDef:
    return {
        "name": ...,
    }


# GetDeliveryDestinationRequestTypeDef definition

class GetDeliveryDestinationRequestTypeDef(TypedDict):
    name: str,

GetDeliveryRequestTypeDef#

# GetDeliveryRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import GetDeliveryRequestTypeDef


def get_value() -> GetDeliveryRequestTypeDef:
    return {
        "id": ...,
    }


# GetDeliveryRequestTypeDef definition

class GetDeliveryRequestTypeDef(TypedDict):
    id: str,

GetDeliverySourceRequestTypeDef#

# GetDeliverySourceRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import GetDeliverySourceRequestTypeDef


def get_value() -> GetDeliverySourceRequestTypeDef:
    return {
        "name": ...,
    }


# GetDeliverySourceRequestTypeDef definition

class GetDeliverySourceRequestTypeDef(TypedDict):
    name: str,

GetIntegrationRequestTypeDef#

# GetIntegrationRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import GetIntegrationRequestTypeDef


def get_value() -> GetIntegrationRequestTypeDef:
    return {
        "integrationName": ...,
    }


# GetIntegrationRequestTypeDef definition

class GetIntegrationRequestTypeDef(TypedDict):
    integrationName: str,

GetLogAnomalyDetectorRequestTypeDef#

# GetLogAnomalyDetectorRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import GetLogAnomalyDetectorRequestTypeDef


def get_value() -> GetLogAnomalyDetectorRequestTypeDef:
    return {
        "anomalyDetectorArn": ...,
    }


# GetLogAnomalyDetectorRequestTypeDef definition

class GetLogAnomalyDetectorRequestTypeDef(TypedDict):
    anomalyDetectorArn: str,

GetLogEventsRequestTypeDef#

# GetLogEventsRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import GetLogEventsRequestTypeDef


def get_value() -> GetLogEventsRequestTypeDef:
    return {
        "logStreamName": ...,
    }


# GetLogEventsRequestTypeDef definition

class GetLogEventsRequestTypeDef(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 TypedDict usage example

from types_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],

GetLogGroupFieldsRequestTypeDef#

# GetLogGroupFieldsRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import GetLogGroupFieldsRequestTypeDef


def get_value() -> GetLogGroupFieldsRequestTypeDef:
    return {
        "logGroupName": ...,
    }


# GetLogGroupFieldsRequestTypeDef definition

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

LogGroupFieldTypeDef#

# LogGroupFieldTypeDef TypedDict usage example

from types_boto3_logs.type_defs import LogGroupFieldTypeDef


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


# LogGroupFieldTypeDef definition

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

GetLogRecordRequestTypeDef#

# GetLogRecordRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import GetLogRecordRequestTypeDef


def get_value() -> GetLogRecordRequestTypeDef:
    return {
        "logRecordPointer": ...,
    }


# GetLogRecordRequestTypeDef definition

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

GetQueryResultsRequestTypeDef#

# GetQueryResultsRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import GetQueryResultsRequestTypeDef


def get_value() -> GetQueryResultsRequestTypeDef:
    return {
        "queryId": ...,
    }


# GetQueryResultsRequestTypeDef definition

class GetQueryResultsRequestTypeDef(TypedDict):
    queryId: str,

QueryStatisticsTypeDef#

# QueryStatisticsTypeDef TypedDict usage example

from types_boto3_logs.type_defs import QueryStatisticsTypeDef


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


# QueryStatisticsTypeDef definition

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

ResultFieldTypeDef#

# ResultFieldTypeDef TypedDict usage example

from types_boto3_logs.type_defs import ResultFieldTypeDef


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


# ResultFieldTypeDef definition

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

GetTransformerRequestTypeDef#

# GetTransformerRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import GetTransformerRequestTypeDef


def get_value() -> GetTransformerRequestTypeDef:
    return {
        "logGroupIdentifier": ...,
    }


# GetTransformerRequestTypeDef definition

class GetTransformerRequestTypeDef(TypedDict):
    logGroupIdentifier: str,

GrokTypeDef#

# GrokTypeDef TypedDict usage example

from types_boto3_logs.type_defs import GrokTypeDef


def get_value() -> GrokTypeDef:
    return {
        "source": ...,
    }


# GrokTypeDef definition

class GrokTypeDef(TypedDict):
    match: str,
    source: NotRequired[str],

InputLogEventTypeDef#

# InputLogEventTypeDef TypedDict usage example

from types_boto3_logs.type_defs import InputLogEventTypeDef


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


# InputLogEventTypeDef definition

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

IntegrationSummaryTypeDef#

# IntegrationSummaryTypeDef TypedDict usage example

from types_boto3_logs.type_defs import IntegrationSummaryTypeDef


def get_value() -> IntegrationSummaryTypeDef:
    return {
        "integrationName": ...,
    }


# IntegrationSummaryTypeDef definition

class IntegrationSummaryTypeDef(TypedDict):
    integrationName: NotRequired[str],
    integrationType: NotRequired[IntegrationTypeType],  # (1)
    integrationStatus: NotRequired[IntegrationStatusType],  # (2)
  1. See IntegrationTypeType
  2. See IntegrationStatusType

ListAnomaliesRequestTypeDef#

# ListAnomaliesRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import ListAnomaliesRequestTypeDef


def get_value() -> ListAnomaliesRequestTypeDef:
    return {
        "anomalyDetectorArn": ...,
    }


# ListAnomaliesRequestTypeDef definition

class ListAnomaliesRequestTypeDef(TypedDict):
    anomalyDetectorArn: NotRequired[str],
    suppressionState: NotRequired[SuppressionStateType],  # (1)
    limit: NotRequired[int],
    nextToken: NotRequired[str],
  1. See SuppressionStateType

ListIntegrationsRequestTypeDef#

# ListIntegrationsRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import ListIntegrationsRequestTypeDef


def get_value() -> ListIntegrationsRequestTypeDef:
    return {
        "integrationNamePrefix": ...,
    }


# ListIntegrationsRequestTypeDef definition

class ListIntegrationsRequestTypeDef(TypedDict):
    integrationNamePrefix: NotRequired[str],
    integrationType: NotRequired[IntegrationTypeType],  # (1)
    integrationStatus: NotRequired[IntegrationStatusType],  # (2)
  1. See IntegrationTypeType
  2. See IntegrationStatusType

ListLogAnomalyDetectorsRequestTypeDef#

# ListLogAnomalyDetectorsRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import ListLogAnomalyDetectorsRequestTypeDef


def get_value() -> ListLogAnomalyDetectorsRequestTypeDef:
    return {
        "filterLogGroupArn": ...,
    }


# ListLogAnomalyDetectorsRequestTypeDef definition

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

ListLogGroupsForQueryRequestTypeDef#

# ListLogGroupsForQueryRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import ListLogGroupsForQueryRequestTypeDef


def get_value() -> ListLogGroupsForQueryRequestTypeDef:
    return {
        "queryId": ...,
    }


# ListLogGroupsForQueryRequestTypeDef definition

class ListLogGroupsForQueryRequestTypeDef(TypedDict):
    queryId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListTagsForResourceRequestTypeDef#

# ListTagsForResourceRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import ListTagsForResourceRequestTypeDef


def get_value() -> ListTagsForResourceRequestTypeDef:
    return {
        "resourceArn": ...,
    }


# ListTagsForResourceRequestTypeDef definition

class ListTagsForResourceRequestTypeDef(TypedDict):
    resourceArn: str,

ListTagsLogGroupRequestTypeDef#

# ListTagsLogGroupRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import ListTagsLogGroupRequestTypeDef


def get_value() -> ListTagsLogGroupRequestTypeDef:
    return {
        "logGroupName": ...,
    }


# ListTagsLogGroupRequestTypeDef definition

class ListTagsLogGroupRequestTypeDef(TypedDict):
    logGroupName: str,

ListToMapTypeDef#

# ListToMapTypeDef TypedDict usage example

from types_boto3_logs.type_defs import ListToMapTypeDef


def get_value() -> ListToMapTypeDef:
    return {
        "source": ...,
    }


# ListToMapTypeDef definition

class ListToMapTypeDef(TypedDict):
    source: str,
    key: str,
    valueKey: NotRequired[str],
    target: NotRequired[str],
    flatten: NotRequired[bool],
    flattenedElement: NotRequired[FlattenedElementType],  # (1)
  1. See FlattenedElementType

LiveTailSessionLogEventTypeDef#

# LiveTailSessionLogEventTypeDef TypedDict usage example

from types_boto3_logs.type_defs import LiveTailSessionLogEventTypeDef


def get_value() -> LiveTailSessionLogEventTypeDef:
    return {
        "logStreamName": ...,
    }


# LiveTailSessionLogEventTypeDef definition

class LiveTailSessionLogEventTypeDef(TypedDict):
    logStreamName: NotRequired[str],
    logGroupIdentifier: NotRequired[str],
    message: NotRequired[str],
    timestamp: NotRequired[int],
    ingestionTime: NotRequired[int],

LiveTailSessionMetadataTypeDef#

# LiveTailSessionMetadataTypeDef TypedDict usage example

from types_boto3_logs.type_defs import LiveTailSessionMetadataTypeDef


def get_value() -> LiveTailSessionMetadataTypeDef:
    return {
        "sampled": ...,
    }


# LiveTailSessionMetadataTypeDef definition

class LiveTailSessionMetadataTypeDef(TypedDict):
    sampled: NotRequired[bool],

LiveTailSessionStartTypeDef#

# LiveTailSessionStartTypeDef TypedDict usage example

from types_boto3_logs.type_defs import LiveTailSessionStartTypeDef


def get_value() -> LiveTailSessionStartTypeDef:
    return {
        "requestId": ...,
    }


# LiveTailSessionStartTypeDef definition

class LiveTailSessionStartTypeDef(TypedDict):
    requestId: NotRequired[str],
    sessionId: NotRequired[str],
    logGroupIdentifiers: NotRequired[List[str]],
    logStreamNames: NotRequired[List[str]],
    logStreamNamePrefixes: NotRequired[List[str]],
    logEventFilterPattern: NotRequired[str],

LowerCaseStringOutputTypeDef#

# LowerCaseStringOutputTypeDef TypedDict usage example

from types_boto3_logs.type_defs import LowerCaseStringOutputTypeDef


def get_value() -> LowerCaseStringOutputTypeDef:
    return {
        "withKeys": ...,
    }


# LowerCaseStringOutputTypeDef definition

class LowerCaseStringOutputTypeDef(TypedDict):
    withKeys: List[str],

LowerCaseStringTypeDef#

# LowerCaseStringTypeDef TypedDict usage example

from types_boto3_logs.type_defs import LowerCaseStringTypeDef


def get_value() -> LowerCaseStringTypeDef:
    return {
        "withKeys": ...,
    }


# LowerCaseStringTypeDef definition

class LowerCaseStringTypeDef(TypedDict):
    withKeys: Sequence[str],

MetricFilterMatchRecordTypeDef#

# MetricFilterMatchRecordTypeDef TypedDict usage example

from types_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]],

MetricTransformationOutputTypeDef#

# MetricTransformationOutputTypeDef TypedDict usage example

from types_boto3_logs.type_defs import MetricTransformationOutputTypeDef


def get_value() -> MetricTransformationOutputTypeDef:
    return {
        "metricName": ...,
    }


# MetricTransformationOutputTypeDef definition

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

MetricTransformationTypeDef#

# MetricTransformationTypeDef TypedDict usage example

from types_boto3_logs.type_defs import MetricTransformationTypeDef


def get_value() -> MetricTransformationTypeDef:
    return {
        "metricName": ...,
    }


# MetricTransformationTypeDef definition

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

MoveKeyEntryTypeDef#

# MoveKeyEntryTypeDef TypedDict usage example

from types_boto3_logs.type_defs import MoveKeyEntryTypeDef


def get_value() -> MoveKeyEntryTypeDef:
    return {
        "source": ...,
    }


# MoveKeyEntryTypeDef definition

class MoveKeyEntryTypeDef(TypedDict):
    source: str,
    target: str,
    overwriteIfExists: NotRequired[bool],

OpenSearchResourceStatusTypeDef#

# OpenSearchResourceStatusTypeDef TypedDict usage example

from types_boto3_logs.type_defs import OpenSearchResourceStatusTypeDef


def get_value() -> OpenSearchResourceStatusTypeDef:
    return {
        "status": ...,
    }


# OpenSearchResourceStatusTypeDef definition

class OpenSearchResourceStatusTypeDef(TypedDict):
    status: NotRequired[OpenSearchResourceStatusTypeType],  # (1)
    statusMessage: NotRequired[str],
  1. See OpenSearchResourceStatusTypeType

OpenSearchResourceConfigTypeDef#

# OpenSearchResourceConfigTypeDef TypedDict usage example

from types_boto3_logs.type_defs import OpenSearchResourceConfigTypeDef


def get_value() -> OpenSearchResourceConfigTypeDef:
    return {
        "kmsKeyArn": ...,
    }


# OpenSearchResourceConfigTypeDef definition

class OpenSearchResourceConfigTypeDef(TypedDict):
    dataSourceRoleArn: str,
    dashboardViewerPrincipals: Sequence[str],
    retentionDays: int,
    kmsKeyArn: NotRequired[str],
    applicationArn: NotRequired[str],

ParseCloudfrontTypeDef#

# ParseCloudfrontTypeDef TypedDict usage example

from types_boto3_logs.type_defs import ParseCloudfrontTypeDef


def get_value() -> ParseCloudfrontTypeDef:
    return {
        "source": ...,
    }


# ParseCloudfrontTypeDef definition

class ParseCloudfrontTypeDef(TypedDict):
    source: NotRequired[str],

ParseJSONTypeDef#

# ParseJSONTypeDef TypedDict usage example

from types_boto3_logs.type_defs import ParseJSONTypeDef


def get_value() -> ParseJSONTypeDef:
    return {
        "source": ...,
    }


# ParseJSONTypeDef definition

class ParseJSONTypeDef(TypedDict):
    source: NotRequired[str],
    destination: NotRequired[str],

ParseKeyValueTypeDef#

# ParseKeyValueTypeDef TypedDict usage example

from types_boto3_logs.type_defs import ParseKeyValueTypeDef


def get_value() -> ParseKeyValueTypeDef:
    return {
        "source": ...,
    }


# ParseKeyValueTypeDef definition

class ParseKeyValueTypeDef(TypedDict):
    source: NotRequired[str],
    destination: NotRequired[str],
    fieldDelimiter: NotRequired[str],
    keyValueDelimiter: NotRequired[str],
    keyPrefix: NotRequired[str],
    nonMatchValue: NotRequired[str],
    overwriteIfExists: NotRequired[bool],

ParsePostgresTypeDef#

# ParsePostgresTypeDef TypedDict usage example

from types_boto3_logs.type_defs import ParsePostgresTypeDef


def get_value() -> ParsePostgresTypeDef:
    return {
        "source": ...,
    }


# ParsePostgresTypeDef definition

class ParsePostgresTypeDef(TypedDict):
    source: NotRequired[str],

ParseRoute53TypeDef#

# ParseRoute53TypeDef TypedDict usage example

from types_boto3_logs.type_defs import ParseRoute53TypeDef


def get_value() -> ParseRoute53TypeDef:
    return {
        "source": ...,
    }


# ParseRoute53TypeDef definition

class ParseRoute53TypeDef(TypedDict):
    source: NotRequired[str],

ParseVPCTypeDef#

# ParseVPCTypeDef TypedDict usage example

from types_boto3_logs.type_defs import ParseVPCTypeDef


def get_value() -> ParseVPCTypeDef:
    return {
        "source": ...,
    }


# ParseVPCTypeDef definition

class ParseVPCTypeDef(TypedDict):
    source: NotRequired[str],

ParseWAFTypeDef#

# ParseWAFTypeDef TypedDict usage example

from types_boto3_logs.type_defs import ParseWAFTypeDef


def get_value() -> ParseWAFTypeDef:
    return {
        "source": ...,
    }


# ParseWAFTypeDef definition

class ParseWAFTypeDef(TypedDict):
    source: NotRequired[str],

TrimStringOutputTypeDef#

# TrimStringOutputTypeDef TypedDict usage example

from types_boto3_logs.type_defs import TrimStringOutputTypeDef


def get_value() -> TrimStringOutputTypeDef:
    return {
        "withKeys": ...,
    }


# TrimStringOutputTypeDef definition

class TrimStringOutputTypeDef(TypedDict):
    withKeys: List[str],

UpperCaseStringOutputTypeDef#

# UpperCaseStringOutputTypeDef TypedDict usage example

from types_boto3_logs.type_defs import UpperCaseStringOutputTypeDef


def get_value() -> UpperCaseStringOutputTypeDef:
    return {
        "withKeys": ...,
    }


# UpperCaseStringOutputTypeDef definition

class UpperCaseStringOutputTypeDef(TypedDict):
    withKeys: List[str],

PutAccountPolicyRequestTypeDef#

# PutAccountPolicyRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import PutAccountPolicyRequestTypeDef


def get_value() -> PutAccountPolicyRequestTypeDef:
    return {
        "policyName": ...,
    }


# PutAccountPolicyRequestTypeDef definition

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

PutDataProtectionPolicyRequestTypeDef#

# PutDataProtectionPolicyRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import PutDataProtectionPolicyRequestTypeDef


def get_value() -> PutDataProtectionPolicyRequestTypeDef:
    return {
        "logGroupIdentifier": ...,
    }


# PutDataProtectionPolicyRequestTypeDef definition

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

PutDeliveryDestinationPolicyRequestTypeDef#

# PutDeliveryDestinationPolicyRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import PutDeliveryDestinationPolicyRequestTypeDef


def get_value() -> PutDeliveryDestinationPolicyRequestTypeDef:
    return {
        "deliveryDestinationName": ...,
    }


# PutDeliveryDestinationPolicyRequestTypeDef definition

class PutDeliveryDestinationPolicyRequestTypeDef(TypedDict):
    deliveryDestinationName: str,
    deliveryDestinationPolicy: str,

PutDeliverySourceRequestTypeDef#

# PutDeliverySourceRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import PutDeliverySourceRequestTypeDef


def get_value() -> PutDeliverySourceRequestTypeDef:
    return {
        "name": ...,
    }


# PutDeliverySourceRequestTypeDef definition

class PutDeliverySourceRequestTypeDef(TypedDict):
    name: str,
    resourceArn: str,
    logType: str,
    tags: NotRequired[Mapping[str, str]],

PutDestinationPolicyRequestTypeDef#

# PutDestinationPolicyRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import PutDestinationPolicyRequestTypeDef


def get_value() -> PutDestinationPolicyRequestTypeDef:
    return {
        "destinationName": ...,
    }


# PutDestinationPolicyRequestTypeDef definition

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

PutDestinationRequestTypeDef#

# PutDestinationRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import PutDestinationRequestTypeDef


def get_value() -> PutDestinationRequestTypeDef:
    return {
        "destinationName": ...,
    }


# PutDestinationRequestTypeDef definition

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

PutIndexPolicyRequestTypeDef#

# PutIndexPolicyRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import PutIndexPolicyRequestTypeDef


def get_value() -> PutIndexPolicyRequestTypeDef:
    return {
        "logGroupIdentifier": ...,
    }


# PutIndexPolicyRequestTypeDef definition

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

RejectedEntityInfoTypeDef#

# RejectedEntityInfoTypeDef TypedDict usage example

from types_boto3_logs.type_defs import RejectedEntityInfoTypeDef


def get_value() -> RejectedEntityInfoTypeDef:
    return {
        "errorType": ...,
    }


# RejectedEntityInfoTypeDef definition

class RejectedEntityInfoTypeDef(TypedDict):
    errorType: EntityRejectionErrorTypeType,  # (1)
  1. See EntityRejectionErrorTypeType

RejectedLogEventsInfoTypeDef#

# RejectedLogEventsInfoTypeDef TypedDict usage example

from types_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],

PutQueryDefinitionRequestTypeDef#

# PutQueryDefinitionRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import PutQueryDefinitionRequestTypeDef


def get_value() -> PutQueryDefinitionRequestTypeDef:
    return {
        "name": ...,
    }


# PutQueryDefinitionRequestTypeDef definition

class PutQueryDefinitionRequestTypeDef(TypedDict):
    name: str,
    queryString: str,
    queryLanguage: NotRequired[QueryLanguageType],  # (1)
    queryDefinitionId: NotRequired[str],
    logGroupNames: NotRequired[Sequence[str]],
    clientToken: NotRequired[str],
  1. See QueryLanguageType

PutResourcePolicyRequestTypeDef#

# PutResourcePolicyRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import PutResourcePolicyRequestTypeDef


def get_value() -> PutResourcePolicyRequestTypeDef:
    return {
        "policyName": ...,
    }


# PutResourcePolicyRequestTypeDef definition

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

PutRetentionPolicyRequestTypeDef#

# PutRetentionPolicyRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import PutRetentionPolicyRequestTypeDef


def get_value() -> PutRetentionPolicyRequestTypeDef:
    return {
        "logGroupName": ...,
    }


# PutRetentionPolicyRequestTypeDef definition

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

PutSubscriptionFilterRequestTypeDef#

# PutSubscriptionFilterRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import PutSubscriptionFilterRequestTypeDef


def get_value() -> PutSubscriptionFilterRequestTypeDef:
    return {
        "logGroupName": ...,
    }


# PutSubscriptionFilterRequestTypeDef definition

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

RenameKeyEntryTypeDef#

# RenameKeyEntryTypeDef TypedDict usage example

from types_boto3_logs.type_defs import RenameKeyEntryTypeDef


def get_value() -> RenameKeyEntryTypeDef:
    return {
        "key": ...,
    }


# RenameKeyEntryTypeDef definition

class RenameKeyEntryTypeDef(TypedDict):
    key: str,
    renameTo: str,
    overwriteIfExists: NotRequired[bool],

SessionStreamingExceptionTypeDef#

# SessionStreamingExceptionTypeDef TypedDict usage example

from types_boto3_logs.type_defs import SessionStreamingExceptionTypeDef


def get_value() -> SessionStreamingExceptionTypeDef:
    return {
        "message": ...,
    }


# SessionStreamingExceptionTypeDef definition

class SessionStreamingExceptionTypeDef(TypedDict):
    message: NotRequired[str],

SessionTimeoutExceptionTypeDef#

# SessionTimeoutExceptionTypeDef TypedDict usage example

from types_boto3_logs.type_defs import SessionTimeoutExceptionTypeDef


def get_value() -> SessionTimeoutExceptionTypeDef:
    return {
        "message": ...,
    }


# SessionTimeoutExceptionTypeDef definition

class SessionTimeoutExceptionTypeDef(TypedDict):
    message: NotRequired[str],

SplitStringEntryTypeDef#

# SplitStringEntryTypeDef TypedDict usage example

from types_boto3_logs.type_defs import SplitStringEntryTypeDef


def get_value() -> SplitStringEntryTypeDef:
    return {
        "source": ...,
    }


# SplitStringEntryTypeDef definition

class SplitStringEntryTypeDef(TypedDict):
    source: str,
    delimiter: str,

StartLiveTailRequestTypeDef#

# StartLiveTailRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import StartLiveTailRequestTypeDef


def get_value() -> StartLiveTailRequestTypeDef:
    return {
        "logGroupIdentifiers": ...,
    }


# StartLiveTailRequestTypeDef definition

class StartLiveTailRequestTypeDef(TypedDict):
    logGroupIdentifiers: Sequence[str],
    logStreamNames: NotRequired[Sequence[str]],
    logStreamNamePrefixes: NotRequired[Sequence[str]],
    logEventFilterPattern: NotRequired[str],

StartQueryRequestTypeDef#

# StartQueryRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import StartQueryRequestTypeDef


def get_value() -> StartQueryRequestTypeDef:
    return {
        "startTime": ...,
    }


# StartQueryRequestTypeDef definition

class StartQueryRequestTypeDef(TypedDict):
    startTime: int,
    endTime: int,
    queryString: str,
    queryLanguage: NotRequired[QueryLanguageType],  # (1)
    logGroupName: NotRequired[str],
    logGroupNames: NotRequired[Sequence[str]],
    logGroupIdentifiers: NotRequired[Sequence[str]],
    limit: NotRequired[int],
  1. See QueryLanguageType

StopQueryRequestTypeDef#

# StopQueryRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import StopQueryRequestTypeDef


def get_value() -> StopQueryRequestTypeDef:
    return {
        "queryId": ...,
    }


# StopQueryRequestTypeDef definition

class StopQueryRequestTypeDef(TypedDict):
    queryId: str,

SubstituteStringEntryTypeDef#

# SubstituteStringEntryTypeDef TypedDict usage example

from types_boto3_logs.type_defs import SubstituteStringEntryTypeDef


def get_value() -> SubstituteStringEntryTypeDef:
    return {
        "source": ...,
    }


# SubstituteStringEntryTypeDef definition

class SubstituteStringEntryTypeDef(TypedDict):
    source: str,
    from: str,
    to: str,

SuppressionPeriodTypeDef#

# SuppressionPeriodTypeDef TypedDict usage example

from types_boto3_logs.type_defs import SuppressionPeriodTypeDef


def get_value() -> SuppressionPeriodTypeDef:
    return {
        "value": ...,
    }


# SuppressionPeriodTypeDef definition

class SuppressionPeriodTypeDef(TypedDict):
    value: NotRequired[int],
    suppressionUnit: NotRequired[SuppressionUnitType],  # (1)
  1. See SuppressionUnitType

TagLogGroupRequestTypeDef#

# TagLogGroupRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import TagLogGroupRequestTypeDef


def get_value() -> TagLogGroupRequestTypeDef:
    return {
        "logGroupName": ...,
    }


# TagLogGroupRequestTypeDef definition

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

TagResourceRequestTypeDef#

# TagResourceRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import TagResourceRequestTypeDef


def get_value() -> TagResourceRequestTypeDef:
    return {
        "resourceArn": ...,
    }


# TagResourceRequestTypeDef definition

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

TestMetricFilterRequestTypeDef#

# TestMetricFilterRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import TestMetricFilterRequestTypeDef


def get_value() -> TestMetricFilterRequestTypeDef:
    return {
        "filterPattern": ...,
    }


# TestMetricFilterRequestTypeDef definition

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

TransformedLogRecordTypeDef#

# TransformedLogRecordTypeDef TypedDict usage example

from types_boto3_logs.type_defs import TransformedLogRecordTypeDef


def get_value() -> TransformedLogRecordTypeDef:
    return {
        "eventNumber": ...,
    }


# TransformedLogRecordTypeDef definition

class TransformedLogRecordTypeDef(TypedDict):
    eventNumber: NotRequired[int],
    eventMessage: NotRequired[str],
    transformedEventMessage: NotRequired[str],

TrimStringTypeDef#

# TrimStringTypeDef TypedDict usage example

from types_boto3_logs.type_defs import TrimStringTypeDef


def get_value() -> TrimStringTypeDef:
    return {
        "withKeys": ...,
    }


# TrimStringTypeDef definition

class TrimStringTypeDef(TypedDict):
    withKeys: Sequence[str],

TypeConverterEntryTypeDef#

# TypeConverterEntryTypeDef TypedDict usage example

from types_boto3_logs.type_defs import TypeConverterEntryTypeDef


def get_value() -> TypeConverterEntryTypeDef:
    return {
        "key": ...,
    }


# TypeConverterEntryTypeDef definition

class TypeConverterEntryTypeDef(TypedDict):
    key: str,
    type: TypeType,  # (1)
  1. See TypeType

UntagLogGroupRequestTypeDef#

# UntagLogGroupRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import UntagLogGroupRequestTypeDef


def get_value() -> UntagLogGroupRequestTypeDef:
    return {
        "logGroupName": ...,
    }


# UntagLogGroupRequestTypeDef definition

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

UntagResourceRequestTypeDef#

# UntagResourceRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import UntagResourceRequestTypeDef


def get_value() -> UntagResourceRequestTypeDef:
    return {
        "resourceArn": ...,
    }


# UntagResourceRequestTypeDef definition

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

UpdateLogAnomalyDetectorRequestTypeDef#

# UpdateLogAnomalyDetectorRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import UpdateLogAnomalyDetectorRequestTypeDef


def get_value() -> UpdateLogAnomalyDetectorRequestTypeDef:
    return {
        "anomalyDetectorArn": ...,
    }


# UpdateLogAnomalyDetectorRequestTypeDef definition

class UpdateLogAnomalyDetectorRequestTypeDef(TypedDict):
    anomalyDetectorArn: str,
    enabled: bool,
    evaluationFrequency: NotRequired[EvaluationFrequencyType],  # (1)
    filterPattern: NotRequired[str],
    anomalyVisibilityTime: NotRequired[int],
  1. See EvaluationFrequencyType

UpperCaseStringTypeDef#

# UpperCaseStringTypeDef TypedDict usage example

from types_boto3_logs.type_defs import UpperCaseStringTypeDef


def get_value() -> UpperCaseStringTypeDef:
    return {
        "withKeys": ...,
    }


# UpperCaseStringTypeDef definition

class UpperCaseStringTypeDef(TypedDict):
    withKeys: Sequence[str],

AddKeysOutputTypeDef#

# AddKeysOutputTypeDef TypedDict usage example

from types_boto3_logs.type_defs import AddKeysOutputTypeDef


def get_value() -> AddKeysOutputTypeDef:
    return {
        "entries": ...,
    }


# AddKeysOutputTypeDef definition

class AddKeysOutputTypeDef(TypedDict):
    entries: List[AddKeyEntryTypeDef],  # (1)
  1. See AddKeyEntryTypeDef

AddKeysTypeDef#

# AddKeysTypeDef TypedDict usage example

from types_boto3_logs.type_defs import AddKeysTypeDef


def get_value() -> AddKeysTypeDef:
    return {
        "entries": ...,
    }


# AddKeysTypeDef definition

class AddKeysTypeDef(TypedDict):
    entries: Sequence[AddKeyEntryTypeDef],  # (1)
  1. See AddKeyEntryTypeDef

AnomalyTypeDef#

# AnomalyTypeDef TypedDict usage example

from types_boto3_logs.type_defs import AnomalyTypeDef


def get_value() -> AnomalyTypeDef:
    return {
        "anomalyId": ...,
    }


# AnomalyTypeDef definition

class AnomalyTypeDef(TypedDict):
    anomalyId: str,
    patternId: str,
    anomalyDetectorArn: str,
    patternString: str,
    firstSeen: int,
    lastSeen: int,
    description: str,
    active: bool,
    state: StateType,  # (1)
    histogram: Dict[str, int],
    logSamples: List[LogEventTypeDef],  # (2)
    patternTokens: List[PatternTokenTypeDef],  # (3)
    logGroupArnList: List[str],
    patternRegex: NotRequired[str],
    priority: NotRequired[str],
    suppressed: NotRequired[bool],
    suppressedDate: NotRequired[int],
    suppressedUntil: NotRequired[int],
    isPatternLevelSuppression: NotRequired[bool],
  1. See StateType
  2. See LogEventTypeDef
  3. See PatternTokenTypeDef

ConfigurationTemplateDeliveryConfigValuesTypeDef#

# ConfigurationTemplateDeliveryConfigValuesTypeDef TypedDict usage example

from types_boto3_logs.type_defs import ConfigurationTemplateDeliveryConfigValuesTypeDef


def get_value() -> ConfigurationTemplateDeliveryConfigValuesTypeDef:
    return {
        "recordFields": ...,
    }


# ConfigurationTemplateDeliveryConfigValuesTypeDef definition

class ConfigurationTemplateDeliveryConfigValuesTypeDef(TypedDict):
    recordFields: NotRequired[List[str]],
    fieldDelimiter: NotRequired[str],
    s3DeliveryConfiguration: NotRequired[S3DeliveryConfigurationTypeDef],  # (1)
  1. See S3DeliveryConfigurationTypeDef

CreateDeliveryRequestTypeDef#

# CreateDeliveryRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import CreateDeliveryRequestTypeDef


def get_value() -> CreateDeliveryRequestTypeDef:
    return {
        "deliverySourceName": ...,
    }


# CreateDeliveryRequestTypeDef definition

class CreateDeliveryRequestTypeDef(TypedDict):
    deliverySourceName: str,
    deliveryDestinationArn: str,
    recordFields: NotRequired[Sequence[str]],
    fieldDelimiter: NotRequired[str],
    s3DeliveryConfiguration: NotRequired[S3DeliveryConfigurationTypeDef],  # (1)
    tags: NotRequired[Mapping[str, str]],
  1. See S3DeliveryConfigurationTypeDef

DeliveryTypeDef#

# DeliveryTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DeliveryTypeDef


def get_value() -> DeliveryTypeDef:
    return {
        "id": ...,
    }


# DeliveryTypeDef definition

class DeliveryTypeDef(TypedDict):
    id: NotRequired[str],
    arn: NotRequired[str],
    deliverySourceName: NotRequired[str],
    deliveryDestinationArn: NotRequired[str],
    deliveryDestinationType: NotRequired[DeliveryDestinationTypeType],  # (1)
    recordFields: NotRequired[List[str]],
    fieldDelimiter: NotRequired[str],
    s3DeliveryConfiguration: NotRequired[S3DeliveryConfigurationTypeDef],  # (2)
    tags: NotRequired[Dict[str, str]],
  1. See DeliveryDestinationTypeType
  2. See S3DeliveryConfigurationTypeDef

UpdateDeliveryConfigurationRequestTypeDef#

# UpdateDeliveryConfigurationRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import UpdateDeliveryConfigurationRequestTypeDef


def get_value() -> UpdateDeliveryConfigurationRequestTypeDef:
    return {
        "id": ...,
    }


# UpdateDeliveryConfigurationRequestTypeDef definition

class UpdateDeliveryConfigurationRequestTypeDef(TypedDict):
    id: str,
    recordFields: NotRequired[Sequence[str]],
    fieldDelimiter: NotRequired[str],
    s3DeliveryConfiguration: NotRequired[S3DeliveryConfigurationTypeDef],  # (1)
  1. See S3DeliveryConfigurationTypeDef

CopyValueOutputTypeDef#

# CopyValueOutputTypeDef TypedDict usage example

from types_boto3_logs.type_defs import CopyValueOutputTypeDef


def get_value() -> CopyValueOutputTypeDef:
    return {
        "entries": ...,
    }


# CopyValueOutputTypeDef definition

class CopyValueOutputTypeDef(TypedDict):
    entries: List[CopyValueEntryTypeDef],  # (1)
  1. See CopyValueEntryTypeDef

CopyValueTypeDef#

# CopyValueTypeDef TypedDict usage example

from types_boto3_logs.type_defs import CopyValueTypeDef


def get_value() -> CopyValueTypeDef:
    return {
        "entries": ...,
    }


# CopyValueTypeDef definition

class CopyValueTypeDef(TypedDict):
    entries: Sequence[CopyValueEntryTypeDef],  # (1)
  1. See CopyValueEntryTypeDef

CreateExportTaskResponseTypeDef#

# CreateExportTaskResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import CreateExportTaskResponseTypeDef


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


# CreateExportTaskResponseTypeDef definition

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

CreateLogAnomalyDetectorResponseTypeDef#

# CreateLogAnomalyDetectorResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import CreateLogAnomalyDetectorResponseTypeDef


def get_value() -> CreateLogAnomalyDetectorResponseTypeDef:
    return {
        "anomalyDetectorArn": ...,
    }


# CreateLogAnomalyDetectorResponseTypeDef definition

class CreateLogAnomalyDetectorResponseTypeDef(TypedDict):
    anomalyDetectorArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteQueryDefinitionResponseTypeDef#

# DeleteQueryDefinitionResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DeleteQueryDefinitionResponseTypeDef


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


# DeleteQueryDefinitionResponseTypeDef definition

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

DescribeAccountPoliciesResponseTypeDef#

# DescribeAccountPoliciesResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeAccountPoliciesResponseTypeDef


def get_value() -> DescribeAccountPoliciesResponseTypeDef:
    return {
        "accountPolicies": ...,
    }


# DescribeAccountPoliciesResponseTypeDef definition

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

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef TypedDict usage example

from types_boto3_logs.type_defs import EmptyResponseMetadataTypeDef


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


# EmptyResponseMetadataTypeDef definition

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

GetDataProtectionPolicyResponseTypeDef#

# GetDataProtectionPolicyResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import GetDataProtectionPolicyResponseTypeDef


def get_value() -> GetDataProtectionPolicyResponseTypeDef:
    return {
        "logGroupIdentifier": ...,
    }


# GetDataProtectionPolicyResponseTypeDef definition

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

GetLogAnomalyDetectorResponseTypeDef#

# GetLogAnomalyDetectorResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import GetLogAnomalyDetectorResponseTypeDef


def get_value() -> GetLogAnomalyDetectorResponseTypeDef:
    return {
        "detectorName": ...,
    }


# GetLogAnomalyDetectorResponseTypeDef definition

class GetLogAnomalyDetectorResponseTypeDef(TypedDict):
    detectorName: str,
    logGroupArnList: List[str],
    evaluationFrequency: EvaluationFrequencyType,  # (1)
    filterPattern: str,
    anomalyDetectorStatus: AnomalyDetectorStatusType,  # (2)
    kmsKeyId: str,
    creationTimeStamp: int,
    lastModifiedTimeStamp: int,
    anomalyVisibilityTime: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See EvaluationFrequencyType
  2. See AnomalyDetectorStatusType
  3. See ResponseMetadataTypeDef

GetLogRecordResponseTypeDef#

# GetLogRecordResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import GetLogRecordResponseTypeDef


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


# GetLogRecordResponseTypeDef definition

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

ListLogAnomalyDetectorsResponseTypeDef#

# ListLogAnomalyDetectorsResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import ListLogAnomalyDetectorsResponseTypeDef


def get_value() -> ListLogAnomalyDetectorsResponseTypeDef:
    return {
        "anomalyDetectors": ...,
    }


# ListLogAnomalyDetectorsResponseTypeDef definition

class ListLogAnomalyDetectorsResponseTypeDef(TypedDict):
    anomalyDetectors: List[AnomalyDetectorTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See AnomalyDetectorTypeDef
  2. See ResponseMetadataTypeDef

ListLogGroupsForQueryResponseTypeDef#

# ListLogGroupsForQueryResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import ListLogGroupsForQueryResponseTypeDef


def get_value() -> ListLogGroupsForQueryResponseTypeDef:
    return {
        "logGroupIdentifiers": ...,
    }


# ListLogGroupsForQueryResponseTypeDef definition

class ListLogGroupsForQueryResponseTypeDef(TypedDict):
    logGroupIdentifiers: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
    nextToken: NotRequired[str],
  1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import ListTagsForResourceResponseTypeDef


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


# ListTagsForResourceResponseTypeDef definition

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

ListTagsLogGroupResponseTypeDef#

# ListTagsLogGroupResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import ListTagsLogGroupResponseTypeDef


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


# ListTagsLogGroupResponseTypeDef definition

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

PutAccountPolicyResponseTypeDef#

# PutAccountPolicyResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import PutAccountPolicyResponseTypeDef


def get_value() -> PutAccountPolicyResponseTypeDef:
    return {
        "accountPolicy": ...,
    }


# PutAccountPolicyResponseTypeDef definition

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

PutDataProtectionPolicyResponseTypeDef#

# PutDataProtectionPolicyResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import PutDataProtectionPolicyResponseTypeDef


def get_value() -> PutDataProtectionPolicyResponseTypeDef:
    return {
        "logGroupIdentifier": ...,
    }


# PutDataProtectionPolicyResponseTypeDef definition

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

PutIntegrationResponseTypeDef#

# PutIntegrationResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import PutIntegrationResponseTypeDef


def get_value() -> PutIntegrationResponseTypeDef:
    return {
        "integrationName": ...,
    }


# PutIntegrationResponseTypeDef definition

class PutIntegrationResponseTypeDef(TypedDict):
    integrationName: str,
    integrationStatus: IntegrationStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See IntegrationStatusType
  2. See ResponseMetadataTypeDef

PutQueryDefinitionResponseTypeDef#

# PutQueryDefinitionResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import PutQueryDefinitionResponseTypeDef


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


# PutQueryDefinitionResponseTypeDef definition

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

StartQueryResponseTypeDef#

# StartQueryResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import StartQueryResponseTypeDef


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


# StartQueryResponseTypeDef definition

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

StopQueryResponseTypeDef#

# StopQueryResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import StopQueryResponseTypeDef


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


# StopQueryResponseTypeDef definition

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

DeliveryDestinationTypeDef#

# DeliveryDestinationTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DeliveryDestinationTypeDef


def get_value() -> DeliveryDestinationTypeDef:
    return {
        "name": ...,
    }


# DeliveryDestinationTypeDef definition

class DeliveryDestinationTypeDef(TypedDict):
    name: NotRequired[str],
    arn: NotRequired[str],
    deliveryDestinationType: NotRequired[DeliveryDestinationTypeType],  # (1)
    outputFormat: NotRequired[OutputFormatType],  # (2)
    deliveryDestinationConfiguration: NotRequired[DeliveryDestinationConfigurationTypeDef],  # (3)
    tags: NotRequired[Dict[str, str]],
  1. See DeliveryDestinationTypeType
  2. See OutputFormatType
  3. See DeliveryDestinationConfigurationTypeDef

PutDeliveryDestinationRequestTypeDef#

# PutDeliveryDestinationRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import PutDeliveryDestinationRequestTypeDef


def get_value() -> PutDeliveryDestinationRequestTypeDef:
    return {
        "name": ...,
    }


# PutDeliveryDestinationRequestTypeDef definition

class PutDeliveryDestinationRequestTypeDef(TypedDict):
    name: str,
    deliveryDestinationConfiguration: DeliveryDestinationConfigurationTypeDef,  # (1)
    outputFormat: NotRequired[OutputFormatType],  # (2)
    tags: NotRequired[Mapping[str, str]],
  1. See DeliveryDestinationConfigurationTypeDef
  2. See OutputFormatType

DescribeDeliverySourcesResponseTypeDef#

# DescribeDeliverySourcesResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeDeliverySourcesResponseTypeDef


def get_value() -> DescribeDeliverySourcesResponseTypeDef:
    return {
        "deliverySources": ...,
    }


# DescribeDeliverySourcesResponseTypeDef definition

class DescribeDeliverySourcesResponseTypeDef(TypedDict):
    deliverySources: List[DeliverySourceTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See DeliverySourceTypeDef
  2. See ResponseMetadataTypeDef

GetDeliverySourceResponseTypeDef#

# GetDeliverySourceResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import GetDeliverySourceResponseTypeDef


def get_value() -> GetDeliverySourceResponseTypeDef:
    return {
        "deliverySource": ...,
    }


# GetDeliverySourceResponseTypeDef definition

class GetDeliverySourceResponseTypeDef(TypedDict):
    deliverySource: DeliverySourceTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DeliverySourceTypeDef
  2. See ResponseMetadataTypeDef

PutDeliverySourceResponseTypeDef#

# PutDeliverySourceResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import PutDeliverySourceResponseTypeDef


def get_value() -> PutDeliverySourceResponseTypeDef:
    return {
        "deliverySource": ...,
    }


# PutDeliverySourceResponseTypeDef definition

class PutDeliverySourceResponseTypeDef(TypedDict):
    deliverySource: DeliverySourceTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DeliverySourceTypeDef
  2. See ResponseMetadataTypeDef

DescribeConfigurationTemplatesRequestPaginateTypeDef#

# DescribeConfigurationTemplatesRequestPaginateTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeConfigurationTemplatesRequestPaginateTypeDef


def get_value() -> DescribeConfigurationTemplatesRequestPaginateTypeDef:
    return {
        "service": ...,
    }


# DescribeConfigurationTemplatesRequestPaginateTypeDef definition

class DescribeConfigurationTemplatesRequestPaginateTypeDef(TypedDict):
    service: NotRequired[str],
    logTypes: NotRequired[Sequence[str]],
    resourceTypes: NotRequired[Sequence[str]],
    deliveryDestinationTypes: NotRequired[Sequence[DeliveryDestinationTypeType]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See DeliveryDestinationTypeType
  2. See PaginatorConfigTypeDef

DescribeDeliveriesRequestPaginateTypeDef#

# DescribeDeliveriesRequestPaginateTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeDeliveriesRequestPaginateTypeDef


def get_value() -> DescribeDeliveriesRequestPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# DescribeDeliveriesRequestPaginateTypeDef definition

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

DescribeDeliveryDestinationsRequestPaginateTypeDef#

# DescribeDeliveryDestinationsRequestPaginateTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeDeliveryDestinationsRequestPaginateTypeDef


def get_value() -> DescribeDeliveryDestinationsRequestPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# DescribeDeliveryDestinationsRequestPaginateTypeDef definition

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

DescribeDeliverySourcesRequestPaginateTypeDef#

# DescribeDeliverySourcesRequestPaginateTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeDeliverySourcesRequestPaginateTypeDef


def get_value() -> DescribeDeliverySourcesRequestPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# DescribeDeliverySourcesRequestPaginateTypeDef definition

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

DescribeDestinationsRequestPaginateTypeDef#

# DescribeDestinationsRequestPaginateTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeDestinationsRequestPaginateTypeDef


def get_value() -> DescribeDestinationsRequestPaginateTypeDef:
    return {
        "DestinationNamePrefix": ...,
    }


# DescribeDestinationsRequestPaginateTypeDef definition

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

DescribeExportTasksRequestPaginateTypeDef#

# DescribeExportTasksRequestPaginateTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeExportTasksRequestPaginateTypeDef


def get_value() -> DescribeExportTasksRequestPaginateTypeDef:
    return {
        "taskId": ...,
    }


# DescribeExportTasksRequestPaginateTypeDef definition

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

DescribeLogGroupsRequestPaginateTypeDef#

# DescribeLogGroupsRequestPaginateTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeLogGroupsRequestPaginateTypeDef


def get_value() -> DescribeLogGroupsRequestPaginateTypeDef:
    return {
        "accountIdentifiers": ...,
    }


# DescribeLogGroupsRequestPaginateTypeDef definition

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

DescribeLogStreamsRequestPaginateTypeDef#

# DescribeLogStreamsRequestPaginateTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeLogStreamsRequestPaginateTypeDef


def get_value() -> DescribeLogStreamsRequestPaginateTypeDef:
    return {
        "logGroupName": ...,
    }


# DescribeLogStreamsRequestPaginateTypeDef definition

class DescribeLogStreamsRequestPaginateTypeDef(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

DescribeMetricFiltersRequestPaginateTypeDef#

# DescribeMetricFiltersRequestPaginateTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeMetricFiltersRequestPaginateTypeDef


def get_value() -> DescribeMetricFiltersRequestPaginateTypeDef:
    return {
        "logGroupName": ...,
    }


# DescribeMetricFiltersRequestPaginateTypeDef definition

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

DescribeQueriesRequestPaginateTypeDef#

# DescribeQueriesRequestPaginateTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeQueriesRequestPaginateTypeDef


def get_value() -> DescribeQueriesRequestPaginateTypeDef:
    return {
        "logGroupName": ...,
    }


# DescribeQueriesRequestPaginateTypeDef definition

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

DescribeResourcePoliciesRequestPaginateTypeDef#

# DescribeResourcePoliciesRequestPaginateTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeResourcePoliciesRequestPaginateTypeDef


def get_value() -> DescribeResourcePoliciesRequestPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# DescribeResourcePoliciesRequestPaginateTypeDef definition

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

DescribeSubscriptionFiltersRequestPaginateTypeDef#

# DescribeSubscriptionFiltersRequestPaginateTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeSubscriptionFiltersRequestPaginateTypeDef


def get_value() -> DescribeSubscriptionFiltersRequestPaginateTypeDef:
    return {
        "logGroupName": ...,
    }


# DescribeSubscriptionFiltersRequestPaginateTypeDef definition

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

FilterLogEventsRequestPaginateTypeDef#

# FilterLogEventsRequestPaginateTypeDef TypedDict usage example

from types_boto3_logs.type_defs import FilterLogEventsRequestPaginateTypeDef


def get_value() -> FilterLogEventsRequestPaginateTypeDef:
    return {
        "logGroupName": ...,
    }


# FilterLogEventsRequestPaginateTypeDef definition

class FilterLogEventsRequestPaginateTypeDef(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

ListAnomaliesRequestPaginateTypeDef#

# ListAnomaliesRequestPaginateTypeDef TypedDict usage example

from types_boto3_logs.type_defs import ListAnomaliesRequestPaginateTypeDef


def get_value() -> ListAnomaliesRequestPaginateTypeDef:
    return {
        "anomalyDetectorArn": ...,
    }


# ListAnomaliesRequestPaginateTypeDef definition

class ListAnomaliesRequestPaginateTypeDef(TypedDict):
    anomalyDetectorArn: NotRequired[str],
    suppressionState: NotRequired[SuppressionStateType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See SuppressionStateType
  2. See PaginatorConfigTypeDef

ListLogAnomalyDetectorsRequestPaginateTypeDef#

# ListLogAnomalyDetectorsRequestPaginateTypeDef TypedDict usage example

from types_boto3_logs.type_defs import ListLogAnomalyDetectorsRequestPaginateTypeDef


def get_value() -> ListLogAnomalyDetectorsRequestPaginateTypeDef:
    return {
        "filterLogGroupArn": ...,
    }


# ListLogAnomalyDetectorsRequestPaginateTypeDef definition

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

ListLogGroupsForQueryRequestPaginateTypeDef#

# ListLogGroupsForQueryRequestPaginateTypeDef TypedDict usage example

from types_boto3_logs.type_defs import ListLogGroupsForQueryRequestPaginateTypeDef


def get_value() -> ListLogGroupsForQueryRequestPaginateTypeDef:
    return {
        "queryId": ...,
    }


# ListLogGroupsForQueryRequestPaginateTypeDef definition

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

DescribeDestinationsResponseTypeDef#

# DescribeDestinationsResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeDestinationsResponseTypeDef


def get_value() -> DescribeDestinationsResponseTypeDef:
    return {
        "destinations": ...,
    }


# DescribeDestinationsResponseTypeDef definition

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

PutDestinationResponseTypeDef#

# PutDestinationResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import PutDestinationResponseTypeDef


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


# PutDestinationResponseTypeDef definition

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

DescribeFieldIndexesResponseTypeDef#

# DescribeFieldIndexesResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeFieldIndexesResponseTypeDef


def get_value() -> DescribeFieldIndexesResponseTypeDef:
    return {
        "fieldIndexes": ...,
    }


# DescribeFieldIndexesResponseTypeDef definition

class DescribeFieldIndexesResponseTypeDef(TypedDict):
    fieldIndexes: List[FieldIndexTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See FieldIndexTypeDef
  2. See ResponseMetadataTypeDef

DescribeIndexPoliciesResponseTypeDef#

# DescribeIndexPoliciesResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeIndexPoliciesResponseTypeDef


def get_value() -> DescribeIndexPoliciesResponseTypeDef:
    return {
        "indexPolicies": ...,
    }


# DescribeIndexPoliciesResponseTypeDef definition

class DescribeIndexPoliciesResponseTypeDef(TypedDict):
    indexPolicies: List[IndexPolicyTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See IndexPolicyTypeDef
  2. See ResponseMetadataTypeDef

PutIndexPolicyResponseTypeDef#

# PutIndexPolicyResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import PutIndexPolicyResponseTypeDef


def get_value() -> PutIndexPolicyResponseTypeDef:
    return {
        "indexPolicy": ...,
    }


# PutIndexPolicyResponseTypeDef definition

class PutIndexPolicyResponseTypeDef(TypedDict):
    indexPolicy: IndexPolicyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See IndexPolicyTypeDef
  2. See ResponseMetadataTypeDef

DescribeLogGroupsResponseTypeDef#

# DescribeLogGroupsResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeLogGroupsResponseTypeDef


def get_value() -> DescribeLogGroupsResponseTypeDef:
    return {
        "logGroups": ...,
    }


# DescribeLogGroupsResponseTypeDef definition

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

DescribeLogStreamsResponseTypeDef#

# DescribeLogStreamsResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeLogStreamsResponseTypeDef


def get_value() -> DescribeLogStreamsResponseTypeDef:
    return {
        "logStreams": ...,
    }


# DescribeLogStreamsResponseTypeDef definition

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

DescribeQueriesResponseTypeDef#

# DescribeQueriesResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeQueriesResponseTypeDef


def get_value() -> DescribeQueriesResponseTypeDef:
    return {
        "queries": ...,
    }


# DescribeQueriesResponseTypeDef definition

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

DescribeQueryDefinitionsResponseTypeDef#

# DescribeQueryDefinitionsResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeQueryDefinitionsResponseTypeDef


def get_value() -> DescribeQueryDefinitionsResponseTypeDef:
    return {
        "queryDefinitions": ...,
    }


# DescribeQueryDefinitionsResponseTypeDef definition

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

DescribeResourcePoliciesResponseTypeDef#

# DescribeResourcePoliciesResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeResourcePoliciesResponseTypeDef


def get_value() -> DescribeResourcePoliciesResponseTypeDef:
    return {
        "resourcePolicies": ...,
    }


# DescribeResourcePoliciesResponseTypeDef definition

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

PutResourcePolicyResponseTypeDef#

# PutResourcePolicyResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import PutResourcePolicyResponseTypeDef


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


# PutResourcePolicyResponseTypeDef definition

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

DescribeSubscriptionFiltersResponseTypeDef#

# DescribeSubscriptionFiltersResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeSubscriptionFiltersResponseTypeDef


def get_value() -> DescribeSubscriptionFiltersResponseTypeDef:
    return {
        "subscriptionFilters": ...,
    }


# DescribeSubscriptionFiltersResponseTypeDef definition

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

ExportTaskTypeDef#

# ExportTaskTypeDef TypedDict usage example

from types_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 TypedDict usage example

from types_boto3_logs.type_defs import FilterLogEventsResponseTypeDef


def get_value() -> FilterLogEventsResponseTypeDef:
    return {
        "events": ...,
    }


# FilterLogEventsResponseTypeDef definition

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

GetDeliveryDestinationPolicyResponseTypeDef#

# GetDeliveryDestinationPolicyResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import GetDeliveryDestinationPolicyResponseTypeDef


def get_value() -> GetDeliveryDestinationPolicyResponseTypeDef:
    return {
        "policy": ...,
    }


# GetDeliveryDestinationPolicyResponseTypeDef definition

class GetDeliveryDestinationPolicyResponseTypeDef(TypedDict):
    policy: PolicyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PolicyTypeDef
  2. See ResponseMetadataTypeDef

PutDeliveryDestinationPolicyResponseTypeDef#

# PutDeliveryDestinationPolicyResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import PutDeliveryDestinationPolicyResponseTypeDef


def get_value() -> PutDeliveryDestinationPolicyResponseTypeDef:
    return {
        "policy": ...,
    }


# PutDeliveryDestinationPolicyResponseTypeDef definition

class PutDeliveryDestinationPolicyResponseTypeDef(TypedDict):
    policy: PolicyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PolicyTypeDef
  2. See ResponseMetadataTypeDef

GetLogEventsResponseTypeDef#

# GetLogEventsResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import GetLogEventsResponseTypeDef


def get_value() -> GetLogEventsResponseTypeDef:
    return {
        "events": ...,
    }


# GetLogEventsResponseTypeDef definition

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

GetLogGroupFieldsResponseTypeDef#

# GetLogGroupFieldsResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import GetLogGroupFieldsResponseTypeDef


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


# GetLogGroupFieldsResponseTypeDef definition

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

GetQueryResultsResponseTypeDef#

# GetQueryResultsResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import GetQueryResultsResponseTypeDef


def get_value() -> GetQueryResultsResponseTypeDef:
    return {
        "queryLanguage": ...,
    }


# GetQueryResultsResponseTypeDef definition

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

PutLogEventsRequestTypeDef#

# PutLogEventsRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import PutLogEventsRequestTypeDef


def get_value() -> PutLogEventsRequestTypeDef:
    return {
        "logGroupName": ...,
    }


# PutLogEventsRequestTypeDef definition

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

ListIntegrationsResponseTypeDef#

# ListIntegrationsResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import ListIntegrationsResponseTypeDef


def get_value() -> ListIntegrationsResponseTypeDef:
    return {
        "integrationSummaries": ...,
    }


# ListIntegrationsResponseTypeDef definition

class ListIntegrationsResponseTypeDef(TypedDict):
    integrationSummaries: List[IntegrationSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See IntegrationSummaryTypeDef
  2. See ResponseMetadataTypeDef

LiveTailSessionUpdateTypeDef#

# LiveTailSessionUpdateTypeDef TypedDict usage example

from types_boto3_logs.type_defs import LiveTailSessionUpdateTypeDef


def get_value() -> LiveTailSessionUpdateTypeDef:
    return {
        "sessionMetadata": ...,
    }


# LiveTailSessionUpdateTypeDef definition

class LiveTailSessionUpdateTypeDef(TypedDict):
    sessionMetadata: NotRequired[LiveTailSessionMetadataTypeDef],  # (1)
    sessionResults: NotRequired[List[LiveTailSessionLogEventTypeDef]],  # (2)
  1. See LiveTailSessionMetadataTypeDef
  2. See LiveTailSessionLogEventTypeDef

TestMetricFilterResponseTypeDef#

# TestMetricFilterResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import TestMetricFilterResponseTypeDef


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


# TestMetricFilterResponseTypeDef definition

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

MetricFilterTypeDef#

# MetricFilterTypeDef TypedDict usage example

from types_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[MetricTransformationOutputTypeDef]],  # (1)
    creationTime: NotRequired[int],
    logGroupName: NotRequired[str],
    applyOnTransformedLogs: NotRequired[bool],
  1. See MetricTransformationOutputTypeDef

MoveKeysOutputTypeDef#

# MoveKeysOutputTypeDef TypedDict usage example

from types_boto3_logs.type_defs import MoveKeysOutputTypeDef


def get_value() -> MoveKeysOutputTypeDef:
    return {
        "entries": ...,
    }


# MoveKeysOutputTypeDef definition

class MoveKeysOutputTypeDef(TypedDict):
    entries: List[MoveKeyEntryTypeDef],  # (1)
  1. See MoveKeyEntryTypeDef

MoveKeysTypeDef#

# MoveKeysTypeDef TypedDict usage example

from types_boto3_logs.type_defs import MoveKeysTypeDef


def get_value() -> MoveKeysTypeDef:
    return {
        "entries": ...,
    }


# MoveKeysTypeDef definition

class MoveKeysTypeDef(TypedDict):
    entries: Sequence[MoveKeyEntryTypeDef],  # (1)
  1. See MoveKeyEntryTypeDef

OpenSearchApplicationTypeDef#

# OpenSearchApplicationTypeDef TypedDict usage example

from types_boto3_logs.type_defs import OpenSearchApplicationTypeDef


def get_value() -> OpenSearchApplicationTypeDef:
    return {
        "applicationEndpoint": ...,
    }


# OpenSearchApplicationTypeDef definition

class OpenSearchApplicationTypeDef(TypedDict):
    applicationEndpoint: NotRequired[str],
    applicationArn: NotRequired[str],
    applicationId: NotRequired[str],
    status: NotRequired[OpenSearchResourceStatusTypeDef],  # (1)
  1. See OpenSearchResourceStatusTypeDef

OpenSearchCollectionTypeDef#

# OpenSearchCollectionTypeDef TypedDict usage example

from types_boto3_logs.type_defs import OpenSearchCollectionTypeDef


def get_value() -> OpenSearchCollectionTypeDef:
    return {
        "collectionEndpoint": ...,
    }


# OpenSearchCollectionTypeDef definition

class OpenSearchCollectionTypeDef(TypedDict):
    collectionEndpoint: NotRequired[str],
    collectionArn: NotRequired[str],
    status: NotRequired[OpenSearchResourceStatusTypeDef],  # (1)
  1. See OpenSearchResourceStatusTypeDef

OpenSearchDataAccessPolicyTypeDef#

# OpenSearchDataAccessPolicyTypeDef TypedDict usage example

from types_boto3_logs.type_defs import OpenSearchDataAccessPolicyTypeDef


def get_value() -> OpenSearchDataAccessPolicyTypeDef:
    return {
        "policyName": ...,
    }


# OpenSearchDataAccessPolicyTypeDef definition

class OpenSearchDataAccessPolicyTypeDef(TypedDict):
    policyName: NotRequired[str],
    status: NotRequired[OpenSearchResourceStatusTypeDef],  # (1)
  1. See OpenSearchResourceStatusTypeDef

OpenSearchDataSourceTypeDef#

# OpenSearchDataSourceTypeDef TypedDict usage example

from types_boto3_logs.type_defs import OpenSearchDataSourceTypeDef


def get_value() -> OpenSearchDataSourceTypeDef:
    return {
        "dataSourceName": ...,
    }


# OpenSearchDataSourceTypeDef definition

class OpenSearchDataSourceTypeDef(TypedDict):
    dataSourceName: NotRequired[str],
    status: NotRequired[OpenSearchResourceStatusTypeDef],  # (1)
  1. See OpenSearchResourceStatusTypeDef

OpenSearchEncryptionPolicyTypeDef#

# OpenSearchEncryptionPolicyTypeDef TypedDict usage example

from types_boto3_logs.type_defs import OpenSearchEncryptionPolicyTypeDef


def get_value() -> OpenSearchEncryptionPolicyTypeDef:
    return {
        "policyName": ...,
    }


# OpenSearchEncryptionPolicyTypeDef definition

class OpenSearchEncryptionPolicyTypeDef(TypedDict):
    policyName: NotRequired[str],
    status: NotRequired[OpenSearchResourceStatusTypeDef],  # (1)
  1. See OpenSearchResourceStatusTypeDef

OpenSearchLifecyclePolicyTypeDef#

# OpenSearchLifecyclePolicyTypeDef TypedDict usage example

from types_boto3_logs.type_defs import OpenSearchLifecyclePolicyTypeDef


def get_value() -> OpenSearchLifecyclePolicyTypeDef:
    return {
        "policyName": ...,
    }


# OpenSearchLifecyclePolicyTypeDef definition

class OpenSearchLifecyclePolicyTypeDef(TypedDict):
    policyName: NotRequired[str],
    status: NotRequired[OpenSearchResourceStatusTypeDef],  # (1)
  1. See OpenSearchResourceStatusTypeDef

OpenSearchNetworkPolicyTypeDef#

# OpenSearchNetworkPolicyTypeDef TypedDict usage example

from types_boto3_logs.type_defs import OpenSearchNetworkPolicyTypeDef


def get_value() -> OpenSearchNetworkPolicyTypeDef:
    return {
        "policyName": ...,
    }


# OpenSearchNetworkPolicyTypeDef definition

class OpenSearchNetworkPolicyTypeDef(TypedDict):
    policyName: NotRequired[str],
    status: NotRequired[OpenSearchResourceStatusTypeDef],  # (1)
  1. See OpenSearchResourceStatusTypeDef

OpenSearchWorkspaceTypeDef#

# OpenSearchWorkspaceTypeDef TypedDict usage example

from types_boto3_logs.type_defs import OpenSearchWorkspaceTypeDef


def get_value() -> OpenSearchWorkspaceTypeDef:
    return {
        "workspaceId": ...,
    }


# OpenSearchWorkspaceTypeDef definition

class OpenSearchWorkspaceTypeDef(TypedDict):
    workspaceId: NotRequired[str],
    status: NotRequired[OpenSearchResourceStatusTypeDef],  # (1)
  1. See OpenSearchResourceStatusTypeDef

ResourceConfigTypeDef#

# ResourceConfigTypeDef TypedDict usage example

from types_boto3_logs.type_defs import ResourceConfigTypeDef


def get_value() -> ResourceConfigTypeDef:
    return {
        "openSearchResourceConfig": ...,
    }


# ResourceConfigTypeDef definition

class ResourceConfigTypeDef(TypedDict):
    openSearchResourceConfig: NotRequired[OpenSearchResourceConfigTypeDef],  # (1)
  1. See OpenSearchResourceConfigTypeDef

PutLogEventsResponseTypeDef#

# PutLogEventsResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import PutLogEventsResponseTypeDef


def get_value() -> PutLogEventsResponseTypeDef:
    return {
        "nextSequenceToken": ...,
    }


# PutLogEventsResponseTypeDef definition

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

RenameKeysOutputTypeDef#

# RenameKeysOutputTypeDef TypedDict usage example

from types_boto3_logs.type_defs import RenameKeysOutputTypeDef


def get_value() -> RenameKeysOutputTypeDef:
    return {
        "entries": ...,
    }


# RenameKeysOutputTypeDef definition

class RenameKeysOutputTypeDef(TypedDict):
    entries: List[RenameKeyEntryTypeDef],  # (1)
  1. See RenameKeyEntryTypeDef

RenameKeysTypeDef#

# RenameKeysTypeDef TypedDict usage example

from types_boto3_logs.type_defs import RenameKeysTypeDef


def get_value() -> RenameKeysTypeDef:
    return {
        "entries": ...,
    }


# RenameKeysTypeDef definition

class RenameKeysTypeDef(TypedDict):
    entries: Sequence[RenameKeyEntryTypeDef],  # (1)
  1. See RenameKeyEntryTypeDef

SplitStringOutputTypeDef#

# SplitStringOutputTypeDef TypedDict usage example

from types_boto3_logs.type_defs import SplitStringOutputTypeDef


def get_value() -> SplitStringOutputTypeDef:
    return {
        "entries": ...,
    }


# SplitStringOutputTypeDef definition

class SplitStringOutputTypeDef(TypedDict):
    entries: List[SplitStringEntryTypeDef],  # (1)
  1. See SplitStringEntryTypeDef

SplitStringTypeDef#

# SplitStringTypeDef TypedDict usage example

from types_boto3_logs.type_defs import SplitStringTypeDef


def get_value() -> SplitStringTypeDef:
    return {
        "entries": ...,
    }


# SplitStringTypeDef definition

class SplitStringTypeDef(TypedDict):
    entries: Sequence[SplitStringEntryTypeDef],  # (1)
  1. See SplitStringEntryTypeDef

SubstituteStringOutputTypeDef#

# SubstituteStringOutputTypeDef TypedDict usage example

from types_boto3_logs.type_defs import SubstituteStringOutputTypeDef


def get_value() -> SubstituteStringOutputTypeDef:
    return {
        "entries": ...,
    }


# SubstituteStringOutputTypeDef definition

class SubstituteStringOutputTypeDef(TypedDict):
    entries: List[SubstituteStringEntryTypeDef],  # (1)
  1. See SubstituteStringEntryTypeDef

SubstituteStringTypeDef#

# SubstituteStringTypeDef TypedDict usage example

from types_boto3_logs.type_defs import SubstituteStringTypeDef


def get_value() -> SubstituteStringTypeDef:
    return {
        "entries": ...,
    }


# SubstituteStringTypeDef definition

class SubstituteStringTypeDef(TypedDict):
    entries: Sequence[SubstituteStringEntryTypeDef],  # (1)
  1. See SubstituteStringEntryTypeDef

UpdateAnomalyRequestTypeDef#

# UpdateAnomalyRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import UpdateAnomalyRequestTypeDef


def get_value() -> UpdateAnomalyRequestTypeDef:
    return {
        "anomalyDetectorArn": ...,
    }


# UpdateAnomalyRequestTypeDef definition

class UpdateAnomalyRequestTypeDef(TypedDict):
    anomalyDetectorArn: str,
    anomalyId: NotRequired[str],
    patternId: NotRequired[str],
    suppressionType: NotRequired[SuppressionTypeType],  # (1)
    suppressionPeriod: NotRequired[SuppressionPeriodTypeDef],  # (2)
    baseline: NotRequired[bool],
  1. See SuppressionTypeType
  2. See SuppressionPeriodTypeDef

TestTransformerResponseTypeDef#

# TestTransformerResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import TestTransformerResponseTypeDef


def get_value() -> TestTransformerResponseTypeDef:
    return {
        "transformedLogs": ...,
    }


# TestTransformerResponseTypeDef definition

class TestTransformerResponseTypeDef(TypedDict):
    transformedLogs: List[TransformedLogRecordTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TransformedLogRecordTypeDef
  2. See ResponseMetadataTypeDef

TypeConverterOutputTypeDef#

# TypeConverterOutputTypeDef TypedDict usage example

from types_boto3_logs.type_defs import TypeConverterOutputTypeDef


def get_value() -> TypeConverterOutputTypeDef:
    return {
        "entries": ...,
    }


# TypeConverterOutputTypeDef definition

class TypeConverterOutputTypeDef(TypedDict):
    entries: List[TypeConverterEntryTypeDef],  # (1)
  1. See TypeConverterEntryTypeDef

TypeConverterTypeDef#

# TypeConverterTypeDef TypedDict usage example

from types_boto3_logs.type_defs import TypeConverterTypeDef


def get_value() -> TypeConverterTypeDef:
    return {
        "entries": ...,
    }


# TypeConverterTypeDef definition

class TypeConverterTypeDef(TypedDict):
    entries: Sequence[TypeConverterEntryTypeDef],  # (1)
  1. See TypeConverterEntryTypeDef

ListAnomaliesResponseTypeDef#

# ListAnomaliesResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import ListAnomaliesResponseTypeDef


def get_value() -> ListAnomaliesResponseTypeDef:
    return {
        "anomalies": ...,
    }


# ListAnomaliesResponseTypeDef definition

class ListAnomaliesResponseTypeDef(TypedDict):
    anomalies: List[AnomalyTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See AnomalyTypeDef
  2. See ResponseMetadataTypeDef

ConfigurationTemplateTypeDef#

# ConfigurationTemplateTypeDef TypedDict usage example

from types_boto3_logs.type_defs import ConfigurationTemplateTypeDef


def get_value() -> ConfigurationTemplateTypeDef:
    return {
        "service": ...,
    }


# ConfigurationTemplateTypeDef definition

class ConfigurationTemplateTypeDef(TypedDict):
    service: NotRequired[str],
    logType: NotRequired[str],
    resourceType: NotRequired[str],
    deliveryDestinationType: NotRequired[DeliveryDestinationTypeType],  # (1)
    defaultDeliveryConfigValues: NotRequired[ConfigurationTemplateDeliveryConfigValuesTypeDef],  # (2)
    allowedFields: NotRequired[List[RecordFieldTypeDef]],  # (3)
    allowedOutputFormats: NotRequired[List[OutputFormatType]],  # (4)
    allowedActionForAllowVendedLogsDeliveryForResource: NotRequired[str],
    allowedFieldDelimiters: NotRequired[List[str]],
    allowedSuffixPathFields: NotRequired[List[str]],
  1. See DeliveryDestinationTypeType
  2. See ConfigurationTemplateDeliveryConfigValuesTypeDef
  3. See RecordFieldTypeDef
  4. See OutputFormatType

CreateDeliveryResponseTypeDef#

# CreateDeliveryResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import CreateDeliveryResponseTypeDef


def get_value() -> CreateDeliveryResponseTypeDef:
    return {
        "delivery": ...,
    }


# CreateDeliveryResponseTypeDef definition

class CreateDeliveryResponseTypeDef(TypedDict):
    delivery: DeliveryTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DeliveryTypeDef
  2. See ResponseMetadataTypeDef

DescribeDeliveriesResponseTypeDef#

# DescribeDeliveriesResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeDeliveriesResponseTypeDef


def get_value() -> DescribeDeliveriesResponseTypeDef:
    return {
        "deliveries": ...,
    }


# DescribeDeliveriesResponseTypeDef definition

class DescribeDeliveriesResponseTypeDef(TypedDict):
    deliveries: List[DeliveryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See DeliveryTypeDef
  2. See ResponseMetadataTypeDef

GetDeliveryResponseTypeDef#

# GetDeliveryResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import GetDeliveryResponseTypeDef


def get_value() -> GetDeliveryResponseTypeDef:
    return {
        "delivery": ...,
    }


# GetDeliveryResponseTypeDef definition

class GetDeliveryResponseTypeDef(TypedDict):
    delivery: DeliveryTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DeliveryTypeDef
  2. See ResponseMetadataTypeDef

DescribeDeliveryDestinationsResponseTypeDef#

# DescribeDeliveryDestinationsResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeDeliveryDestinationsResponseTypeDef


def get_value() -> DescribeDeliveryDestinationsResponseTypeDef:
    return {
        "deliveryDestinations": ...,
    }


# DescribeDeliveryDestinationsResponseTypeDef definition

class DescribeDeliveryDestinationsResponseTypeDef(TypedDict):
    deliveryDestinations: List[DeliveryDestinationTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See DeliveryDestinationTypeDef
  2. See ResponseMetadataTypeDef

GetDeliveryDestinationResponseTypeDef#

# GetDeliveryDestinationResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import GetDeliveryDestinationResponseTypeDef


def get_value() -> GetDeliveryDestinationResponseTypeDef:
    return {
        "deliveryDestination": ...,
    }


# GetDeliveryDestinationResponseTypeDef definition

class GetDeliveryDestinationResponseTypeDef(TypedDict):
    deliveryDestination: DeliveryDestinationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DeliveryDestinationTypeDef
  2. See ResponseMetadataTypeDef

PutDeliveryDestinationResponseTypeDef#

# PutDeliveryDestinationResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import PutDeliveryDestinationResponseTypeDef


def get_value() -> PutDeliveryDestinationResponseTypeDef:
    return {
        "deliveryDestination": ...,
    }


# PutDeliveryDestinationResponseTypeDef definition

class PutDeliveryDestinationResponseTypeDef(TypedDict):
    deliveryDestination: DeliveryDestinationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DeliveryDestinationTypeDef
  2. See ResponseMetadataTypeDef

DescribeExportTasksResponseTypeDef#

# DescribeExportTasksResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeExportTasksResponseTypeDef


def get_value() -> DescribeExportTasksResponseTypeDef:
    return {
        "exportTasks": ...,
    }


# DescribeExportTasksResponseTypeDef definition

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

StartLiveTailResponseStreamTypeDef#

# StartLiveTailResponseStreamTypeDef TypedDict usage example

from types_boto3_logs.type_defs import StartLiveTailResponseStreamTypeDef


def get_value() -> StartLiveTailResponseStreamTypeDef:
    return {
        "sessionStart": ...,
    }


# StartLiveTailResponseStreamTypeDef definition

class StartLiveTailResponseStreamTypeDef(TypedDict):
    sessionStart: NotRequired[LiveTailSessionStartTypeDef],  # (1)
    sessionUpdate: NotRequired[LiveTailSessionUpdateTypeDef],  # (2)
    SessionTimeoutException: NotRequired[SessionTimeoutExceptionTypeDef],  # (3)
    SessionStreamingException: NotRequired[SessionStreamingExceptionTypeDef],  # (4)
  1. See LiveTailSessionStartTypeDef
  2. See LiveTailSessionUpdateTypeDef
  3. See SessionTimeoutExceptionTypeDef
  4. See SessionStreamingExceptionTypeDef

DescribeMetricFiltersResponseTypeDef#

# DescribeMetricFiltersResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeMetricFiltersResponseTypeDef


def get_value() -> DescribeMetricFiltersResponseTypeDef:
    return {
        "metricFilters": ...,
    }


# DescribeMetricFiltersResponseTypeDef definition

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

PutMetricFilterRequestTypeDef#

# PutMetricFilterRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import PutMetricFilterRequestTypeDef


def get_value() -> PutMetricFilterRequestTypeDef:
    return {
        "logGroupName": ...,
    }


# PutMetricFilterRequestTypeDef definition

class PutMetricFilterRequestTypeDef(TypedDict):
    logGroupName: str,
    filterName: str,
    filterPattern: str,
    metricTransformations: Sequence[MetricTransformationUnionTypeDef],  # (1)
    applyOnTransformedLogs: NotRequired[bool],
  1. See MetricTransformationTypeDef MetricTransformationOutputTypeDef

OpenSearchIntegrationDetailsTypeDef#

# OpenSearchIntegrationDetailsTypeDef TypedDict usage example

from types_boto3_logs.type_defs import OpenSearchIntegrationDetailsTypeDef


def get_value() -> OpenSearchIntegrationDetailsTypeDef:
    return {
        "dataSource": ...,
    }


# OpenSearchIntegrationDetailsTypeDef definition

class OpenSearchIntegrationDetailsTypeDef(TypedDict):
    dataSource: NotRequired[OpenSearchDataSourceTypeDef],  # (1)
    application: NotRequired[OpenSearchApplicationTypeDef],  # (2)
    collection: NotRequired[OpenSearchCollectionTypeDef],  # (3)
    workspace: NotRequired[OpenSearchWorkspaceTypeDef],  # (4)
    encryptionPolicy: NotRequired[OpenSearchEncryptionPolicyTypeDef],  # (5)
    networkPolicy: NotRequired[OpenSearchNetworkPolicyTypeDef],  # (6)
    accessPolicy: NotRequired[OpenSearchDataAccessPolicyTypeDef],  # (7)
    lifecyclePolicy: NotRequired[OpenSearchLifecyclePolicyTypeDef],  # (8)
  1. See OpenSearchDataSourceTypeDef
  2. See OpenSearchApplicationTypeDef
  3. See OpenSearchCollectionTypeDef
  4. See OpenSearchWorkspaceTypeDef
  5. See OpenSearchEncryptionPolicyTypeDef
  6. See OpenSearchNetworkPolicyTypeDef
  7. See OpenSearchDataAccessPolicyTypeDef
  8. See OpenSearchLifecyclePolicyTypeDef

PutIntegrationRequestTypeDef#

# PutIntegrationRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import PutIntegrationRequestTypeDef


def get_value() -> PutIntegrationRequestTypeDef:
    return {
        "integrationName": ...,
    }


# PutIntegrationRequestTypeDef definition

class PutIntegrationRequestTypeDef(TypedDict):
    integrationName: str,
    resourceConfig: ResourceConfigTypeDef,  # (1)
    integrationType: IntegrationTypeType,  # (2)
  1. See ResourceConfigTypeDef
  2. See IntegrationTypeType

ProcessorOutputTypeDef#

# ProcessorOutputTypeDef TypedDict usage example

from types_boto3_logs.type_defs import ProcessorOutputTypeDef


def get_value() -> ProcessorOutputTypeDef:
    return {
        "addKeys": ...,
    }


# ProcessorOutputTypeDef definition

class ProcessorOutputTypeDef(TypedDict):
    addKeys: NotRequired[AddKeysOutputTypeDef],  # (1)
    copyValue: NotRequired[CopyValueOutputTypeDef],  # (2)
    csv: NotRequired[CSVOutputTypeDef],  # (3)
    dateTimeConverter: NotRequired[DateTimeConverterOutputTypeDef],  # (4)
    deleteKeys: NotRequired[DeleteKeysOutputTypeDef],  # (5)
    grok: NotRequired[GrokTypeDef],  # (6)
    listToMap: NotRequired[ListToMapTypeDef],  # (7)
    lowerCaseString: NotRequired[LowerCaseStringOutputTypeDef],  # (8)
    moveKeys: NotRequired[MoveKeysOutputTypeDef],  # (9)
    parseCloudfront: NotRequired[ParseCloudfrontTypeDef],  # (10)
    parseJSON: NotRequired[ParseJSONTypeDef],  # (11)
    parseKeyValue: NotRequired[ParseKeyValueTypeDef],  # (12)
    parseRoute53: NotRequired[ParseRoute53TypeDef],  # (13)
    parsePostgres: NotRequired[ParsePostgresTypeDef],  # (14)
    parseVPC: NotRequired[ParseVPCTypeDef],  # (15)
    parseWAF: NotRequired[ParseWAFTypeDef],  # (16)
    renameKeys: NotRequired[RenameKeysOutputTypeDef],  # (17)
    splitString: NotRequired[SplitStringOutputTypeDef],  # (18)
    substituteString: NotRequired[SubstituteStringOutputTypeDef],  # (19)
    trimString: NotRequired[TrimStringOutputTypeDef],  # (20)
    typeConverter: NotRequired[TypeConverterOutputTypeDef],  # (21)
    upperCaseString: NotRequired[UpperCaseStringOutputTypeDef],  # (22)
  1. See AddKeysOutputTypeDef
  2. See CopyValueOutputTypeDef
  3. See CSVOutputTypeDef
  4. See DateTimeConverterOutputTypeDef
  5. See DeleteKeysOutputTypeDef
  6. See GrokTypeDef
  7. See ListToMapTypeDef
  8. See LowerCaseStringOutputTypeDef
  9. See MoveKeysOutputTypeDef
  10. See ParseCloudfrontTypeDef
  11. See ParseJSONTypeDef
  12. See ParseKeyValueTypeDef
  13. See ParseRoute53TypeDef
  14. See ParsePostgresTypeDef
  15. See ParseVPCTypeDef
  16. See ParseWAFTypeDef
  17. See RenameKeysOutputTypeDef
  18. See SplitStringOutputTypeDef
  19. See SubstituteStringOutputTypeDef
  20. See TrimStringOutputTypeDef
  21. See TypeConverterOutputTypeDef
  22. See UpperCaseStringOutputTypeDef

DescribeConfigurationTemplatesResponseTypeDef#

# DescribeConfigurationTemplatesResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import DescribeConfigurationTemplatesResponseTypeDef


def get_value() -> DescribeConfigurationTemplatesResponseTypeDef:
    return {
        "configurationTemplates": ...,
    }


# DescribeConfigurationTemplatesResponseTypeDef definition

class DescribeConfigurationTemplatesResponseTypeDef(TypedDict):
    configurationTemplates: List[ConfigurationTemplateTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See ConfigurationTemplateTypeDef
  2. See ResponseMetadataTypeDef

StartLiveTailResponseTypeDef#

# StartLiveTailResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import StartLiveTailResponseTypeDef


def get_value() -> StartLiveTailResponseTypeDef:
    return {
        "responseStream": ...,
    }


# StartLiveTailResponseTypeDef definition

class StartLiveTailResponseTypeDef(TypedDict):
    responseStream: EventStream[StartLiveTailResponseStreamTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StartLiveTailResponseStreamTypeDef
  2. See ResponseMetadataTypeDef

IntegrationDetailsTypeDef#

# IntegrationDetailsTypeDef TypedDict usage example

from types_boto3_logs.type_defs import IntegrationDetailsTypeDef


def get_value() -> IntegrationDetailsTypeDef:
    return {
        "openSearchIntegrationDetails": ...,
    }


# IntegrationDetailsTypeDef definition

class IntegrationDetailsTypeDef(TypedDict):
    openSearchIntegrationDetails: NotRequired[OpenSearchIntegrationDetailsTypeDef],  # (1)
  1. See OpenSearchIntegrationDetailsTypeDef

GetTransformerResponseTypeDef#

# GetTransformerResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import GetTransformerResponseTypeDef


def get_value() -> GetTransformerResponseTypeDef:
    return {
        "logGroupIdentifier": ...,
    }


# GetTransformerResponseTypeDef definition

class GetTransformerResponseTypeDef(TypedDict):
    logGroupIdentifier: str,
    creationTime: int,
    lastModifiedTime: int,
    transformerConfig: List[ProcessorOutputTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ProcessorOutputTypeDef
  2. See ResponseMetadataTypeDef

ProcessorTypeDef#

# ProcessorTypeDef TypedDict usage example

from types_boto3_logs.type_defs import ProcessorTypeDef


def get_value() -> ProcessorTypeDef:
    return {
        "addKeys": ...,
    }


# ProcessorTypeDef definition

class ProcessorTypeDef(TypedDict):
    addKeys: NotRequired[AddKeysUnionTypeDef],  # (1)
    copyValue: NotRequired[CopyValueUnionTypeDef],  # (2)
    csv: NotRequired[CSVUnionTypeDef],  # (3)
    dateTimeConverter: NotRequired[DateTimeConverterUnionTypeDef],  # (4)
    deleteKeys: NotRequired[DeleteKeysUnionTypeDef],  # (5)
    grok: NotRequired[GrokTypeDef],  # (6)
    listToMap: NotRequired[ListToMapTypeDef],  # (7)
    lowerCaseString: NotRequired[LowerCaseStringUnionTypeDef],  # (8)
    moveKeys: NotRequired[MoveKeysUnionTypeDef],  # (9)
    parseCloudfront: NotRequired[ParseCloudfrontTypeDef],  # (10)
    parseJSON: NotRequired[ParseJSONTypeDef],  # (11)
    parseKeyValue: NotRequired[ParseKeyValueTypeDef],  # (12)
    parseRoute53: NotRequired[ParseRoute53TypeDef],  # (13)
    parsePostgres: NotRequired[ParsePostgresTypeDef],  # (14)
    parseVPC: NotRequired[ParseVPCTypeDef],  # (15)
    parseWAF: NotRequired[ParseWAFTypeDef],  # (16)
    renameKeys: NotRequired[RenameKeysUnionTypeDef],  # (17)
    splitString: NotRequired[SplitStringUnionTypeDef],  # (18)
    substituteString: NotRequired[SubstituteStringUnionTypeDef],  # (19)
    trimString: NotRequired[TrimStringUnionTypeDef],  # (20)
    typeConverter: NotRequired[TypeConverterUnionTypeDef],  # (21)
    upperCaseString: NotRequired[UpperCaseStringUnionTypeDef],  # (22)
  1. See AddKeysTypeDef AddKeysOutputTypeDef
  2. See CopyValueTypeDef CopyValueOutputTypeDef
  3. See CSVTypeDef CSVOutputTypeDef
  4. See DateTimeConverterTypeDef DateTimeConverterOutputTypeDef
  5. See DeleteKeysTypeDef DeleteKeysOutputTypeDef
  6. See GrokTypeDef
  7. See ListToMapTypeDef
  8. See LowerCaseStringTypeDef LowerCaseStringOutputTypeDef
  9. See MoveKeysTypeDef MoveKeysOutputTypeDef
  10. See ParseCloudfrontTypeDef
  11. See ParseJSONTypeDef
  12. See ParseKeyValueTypeDef
  13. See ParseRoute53TypeDef
  14. See ParsePostgresTypeDef
  15. See ParseVPCTypeDef
  16. See ParseWAFTypeDef
  17. See RenameKeysTypeDef RenameKeysOutputTypeDef
  18. See SplitStringTypeDef SplitStringOutputTypeDef
  19. See SubstituteStringTypeDef SubstituteStringOutputTypeDef
  20. See TrimStringTypeDef TrimStringOutputTypeDef
  21. See TypeConverterTypeDef TypeConverterOutputTypeDef
  22. See UpperCaseStringTypeDef UpperCaseStringOutputTypeDef

GetIntegrationResponseTypeDef#

# GetIntegrationResponseTypeDef TypedDict usage example

from types_boto3_logs.type_defs import GetIntegrationResponseTypeDef


def get_value() -> GetIntegrationResponseTypeDef:
    return {
        "integrationName": ...,
    }


# GetIntegrationResponseTypeDef definition

class GetIntegrationResponseTypeDef(TypedDict):
    integrationName: str,
    integrationType: IntegrationTypeType,  # (1)
    integrationStatus: IntegrationStatusType,  # (2)
    integrationDetails: IntegrationDetailsTypeDef,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See IntegrationTypeType
  2. See IntegrationStatusType
  3. See IntegrationDetailsTypeDef
  4. See ResponseMetadataTypeDef

PutTransformerRequestTypeDef#

# PutTransformerRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import PutTransformerRequestTypeDef


def get_value() -> PutTransformerRequestTypeDef:
    return {
        "logGroupIdentifier": ...,
    }


# PutTransformerRequestTypeDef definition

class PutTransformerRequestTypeDef(TypedDict):
    logGroupIdentifier: str,
    transformerConfig: Sequence[ProcessorUnionTypeDef],  # (1)
  1. See ProcessorTypeDef ProcessorOutputTypeDef

TestTransformerRequestTypeDef#

# TestTransformerRequestTypeDef TypedDict usage example

from types_boto3_logs.type_defs import TestTransformerRequestTypeDef


def get_value() -> TestTransformerRequestTypeDef:
    return {
        "transformerConfig": ...,
    }


# TestTransformerRequestTypeDef definition

class TestTransformerRequestTypeDef(TypedDict):
    transformerConfig: Sequence[ProcessorUnionTypeDef],  # (1)
    logEventMessages: Sequence[str],
  1. See ProcessorTypeDef ProcessorOutputTypeDef