Skip to content

Type definitions#

Index > CloudWatchLogs > Type definitions

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

AccountPolicyTypeDef#

# AccountPolicyTypeDef definition

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

AnomalyDetectorTypeDef#

# 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

PatternTokenTypeDef#

# PatternTokenTypeDef definition

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

AssociateKmsKeyRequestRequestTypeDef#

# AssociateKmsKeyRequestRequestTypeDef definition

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

CancelExportTaskRequestRequestTypeDef#

# CancelExportTaskRequestRequestTypeDef definition

class CancelExportTaskRequestRequestTypeDef(TypedDict):
    taskId: str,

CreateDeliveryRequestRequestTypeDef#

# CreateDeliveryRequestRequestTypeDef definition

class CreateDeliveryRequestRequestTypeDef(TypedDict):
    deliverySourceName: str,
    deliveryDestinationArn: str,
    tags: NotRequired[Mapping[str, str]],

DeliveryTypeDef#

# DeliveryTypeDef definition

class DeliveryTypeDef(TypedDict):
    id: NotRequired[str],
    arn: NotRequired[str],
    deliverySourceName: NotRequired[str],
    deliveryDestinationArn: NotRequired[str],
    deliveryDestinationType: NotRequired[DeliveryDestinationTypeType],  # (1)
    tags: NotRequired[Dict[str, str]],
  1. See DeliveryDestinationTypeType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

CreateExportTaskRequestRequestTypeDef#

# CreateExportTaskRequestRequestTypeDef definition

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

CreateLogAnomalyDetectorRequestRequestTypeDef#

# CreateLogAnomalyDetectorRequestRequestTypeDef definition

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

CreateLogGroupRequestRequestTypeDef#

# CreateLogGroupRequestRequestTypeDef definition

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

CreateLogStreamRequestRequestTypeDef#

# CreateLogStreamRequestRequestTypeDef definition

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

DeleteAccountPolicyRequestRequestTypeDef#

# DeleteAccountPolicyRequestRequestTypeDef definition

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

DeleteDataProtectionPolicyRequestRequestTypeDef#

# DeleteDataProtectionPolicyRequestRequestTypeDef definition

class DeleteDataProtectionPolicyRequestRequestTypeDef(TypedDict):
    logGroupIdentifier: str,

DeleteDeliveryDestinationPolicyRequestRequestTypeDef#

# DeleteDeliveryDestinationPolicyRequestRequestTypeDef definition

class DeleteDeliveryDestinationPolicyRequestRequestTypeDef(TypedDict):
    deliveryDestinationName: str,

DeleteDeliveryDestinationRequestRequestTypeDef#

# DeleteDeliveryDestinationRequestRequestTypeDef definition

class DeleteDeliveryDestinationRequestRequestTypeDef(TypedDict):
    name: str,

DeleteDeliveryRequestRequestTypeDef#

# DeleteDeliveryRequestRequestTypeDef definition

class DeleteDeliveryRequestRequestTypeDef(TypedDict):
    id: str,

DeleteDeliverySourceRequestRequestTypeDef#

# DeleteDeliverySourceRequestRequestTypeDef definition

class DeleteDeliverySourceRequestRequestTypeDef(TypedDict):
    name: str,

DeleteDestinationRequestRequestTypeDef#

# DeleteDestinationRequestRequestTypeDef definition

class DeleteDestinationRequestRequestTypeDef(TypedDict):
    destinationName: str,

DeleteLogAnomalyDetectorRequestRequestTypeDef#

# DeleteLogAnomalyDetectorRequestRequestTypeDef definition

class DeleteLogAnomalyDetectorRequestRequestTypeDef(TypedDict):
    anomalyDetectorArn: str,

DeleteLogGroupRequestRequestTypeDef#

# DeleteLogGroupRequestRequestTypeDef definition

class DeleteLogGroupRequestRequestTypeDef(TypedDict):
    logGroupName: str,

DeleteLogStreamRequestRequestTypeDef#

# DeleteLogStreamRequestRequestTypeDef definition

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

DeleteMetricFilterRequestRequestTypeDef#

# DeleteMetricFilterRequestRequestTypeDef definition

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

DeleteQueryDefinitionRequestRequestTypeDef#

# DeleteQueryDefinitionRequestRequestTypeDef definition

class DeleteQueryDefinitionRequestRequestTypeDef(TypedDict):
    queryDefinitionId: str,

DeleteResourcePolicyRequestRequestTypeDef#

# DeleteResourcePolicyRequestRequestTypeDef definition

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

DeleteRetentionPolicyRequestRequestTypeDef#

# DeleteRetentionPolicyRequestRequestTypeDef definition

class DeleteRetentionPolicyRequestRequestTypeDef(TypedDict):
    logGroupName: str,

DeleteSubscriptionFilterRequestRequestTypeDef#

# DeleteSubscriptionFilterRequestRequestTypeDef definition

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

DeliveryDestinationConfigurationTypeDef#

# DeliveryDestinationConfigurationTypeDef definition

class DeliveryDestinationConfigurationTypeDef(TypedDict):
    destinationResourceArn: str,

DeliverySourceTypeDef#

# 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]],

DescribeAccountPoliciesRequestRequestTypeDef#

# DescribeAccountPoliciesRequestRequestTypeDef definition

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

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

DescribeDeliveriesRequestRequestTypeDef#

# DescribeDeliveriesRequestRequestTypeDef definition

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

DescribeDeliveryDestinationsRequestRequestTypeDef#

# DescribeDeliveryDestinationsRequestRequestTypeDef definition

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

DescribeDeliverySourcesRequestRequestTypeDef#

# DescribeDeliverySourcesRequestRequestTypeDef definition

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

DescribeDestinationsRequestRequestTypeDef#

# DescribeDestinationsRequestRequestTypeDef definition

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

DestinationTypeDef#

# DestinationTypeDef definition

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

DescribeExportTasksRequestRequestTypeDef#

# DescribeExportTasksRequestRequestTypeDef definition

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

DescribeLogGroupsRequestRequestTypeDef#

# DescribeLogGroupsRequestRequestTypeDef definition

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

LogGroupTypeDef#

# LogGroupTypeDef definition

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

DescribeLogStreamsRequestRequestTypeDef#

# DescribeLogStreamsRequestRequestTypeDef definition

class DescribeLogStreamsRequestReque