Skip to content

Type definitions#

Index > MailManager > Type definitions

Auto-generated documentation for MailManager type annotations stubs module mypy-boto3-mailmanager.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

ReplaceRecipientActionUnionTypeDef#

# ReplaceRecipientActionUnionTypeDef definition

ReplaceRecipientActionUnionTypeDef = Union[
    ReplaceRecipientActionTypeDef,  # (1)
    ReplaceRecipientActionOutputTypeDef,  # (2)
]
  1. See ReplaceRecipientActionTypeDef
  2. See ReplaceRecipientActionOutputTypeDef

RuleDmarcExpressionUnionTypeDef#

# RuleDmarcExpressionUnionTypeDef definition

RuleDmarcExpressionUnionTypeDef = Union[
    RuleDmarcExpressionTypeDef,  # (1)
    RuleDmarcExpressionOutputTypeDef,  # (2)
]
  1. See RuleDmarcExpressionTypeDef
  2. See RuleDmarcExpressionOutputTypeDef

ArchiveStringExpressionUnionTypeDef#

# ArchiveStringExpressionUnionTypeDef definition

ArchiveStringExpressionUnionTypeDef = Union[
    ArchiveStringExpressionTypeDef,  # (1)
    ArchiveStringExpressionOutputTypeDef,  # (2)
]
  1. See ArchiveStringExpressionTypeDef
  2. See ArchiveStringExpressionOutputTypeDef

IngressIpv4ExpressionUnionTypeDef#

# IngressIpv4ExpressionUnionTypeDef definition

IngressIpv4ExpressionUnionTypeDef = Union[
    IngressIpv4ExpressionTypeDef,  # (1)
    IngressIpv4ExpressionOutputTypeDef,  # (2)
]
  1. See IngressIpv4ExpressionTypeDef
  2. See IngressIpv4ExpressionOutputTypeDef

IngressStringExpressionUnionTypeDef#

# IngressStringExpressionUnionTypeDef definition

IngressStringExpressionUnionTypeDef = Union[
    IngressStringExpressionTypeDef,  # (1)
    IngressStringExpressionOutputTypeDef,  # (2)
]
  1. See IngressStringExpressionTypeDef
  2. See IngressStringExpressionOutputTypeDef

RuleIpExpressionUnionTypeDef#

# RuleIpExpressionUnionTypeDef definition

RuleIpExpressionUnionTypeDef = Union[
    RuleIpExpressionTypeDef,  # (1)
    RuleIpExpressionOutputTypeDef,  # (2)
]
  1. See RuleIpExpressionTypeDef
  2. See RuleIpExpressionOutputTypeDef

RuleStringExpressionUnionTypeDef#

# RuleStringExpressionUnionTypeDef definition

RuleStringExpressionUnionTypeDef = Union[
    RuleStringExpressionTypeDef,  # (1)
    RuleStringExpressionOutputTypeDef,  # (2)
]
  1. See RuleStringExpressionTypeDef
  2. See RuleStringExpressionOutputTypeDef

RuleVerdictExpressionUnionTypeDef#

# RuleVerdictExpressionUnionTypeDef definition

RuleVerdictExpressionUnionTypeDef = Union[
    RuleVerdictExpressionTypeDef,  # (1)
    RuleVerdictExpressionOutputTypeDef,  # (2)
]
  1. See RuleVerdictExpressionTypeDef
  2. See RuleVerdictExpressionOutputTypeDef

RuleActionUnionTypeDef#

# RuleActionUnionTypeDef definition

RuleActionUnionTypeDef = Union[
    RuleActionTypeDef,  # (1)
    RuleActionOutputTypeDef,  # (2)
]
  1. See RuleActionTypeDef
  2. See RuleActionOutputTypeDef

ArchiveFilterConditionUnionTypeDef#

# ArchiveFilterConditionUnionTypeDef definition

ArchiveFilterConditionUnionTypeDef = Union[
    ArchiveFilterConditionTypeDef,  # (1)
    ArchiveFilterConditionOutputTypeDef,  # (2)
]
  1. See ArchiveFilterConditionTypeDef
  2. See ArchiveFilterConditionOutputTypeDef

PolicyConditionUnionTypeDef#

# PolicyConditionUnionTypeDef definition

PolicyConditionUnionTypeDef = Union[
    PolicyConditionTypeDef,  # (1)
    PolicyConditionOutputTypeDef,  # (2)
]
  1. See PolicyConditionTypeDef
  2. See PolicyConditionOutputTypeDef

RuleConditionUnionTypeDef#

# RuleConditionUnionTypeDef definition

RuleConditionUnionTypeDef = Union[
    RuleConditionTypeDef,  # (1)
    RuleConditionOutputTypeDef,  # (2)
]
  1. See RuleConditionTypeDef
  2. See RuleConditionOutputTypeDef

PolicyStatementUnionTypeDef#

# PolicyStatementUnionTypeDef definition

PolicyStatementUnionTypeDef = Union[
    PolicyStatementTypeDef,  # (1)
    PolicyStatementOutputTypeDef,  # (2)
]
  1. See PolicyStatementTypeDef
  2. See PolicyStatementOutputTypeDef

RuleUnionTypeDef#

# RuleUnionTypeDef definition

RuleUnionTypeDef = Union[
    RuleTypeDef,  # (1)
    RuleOutputTypeDef,  # (2)
]
  1. See RuleTypeDef
  2. See RuleOutputTypeDef

AddHeaderActionTypeDef#

# AddHeaderActionTypeDef definition

class AddHeaderActionTypeDef(TypedDict):
    HeaderName: str,
    HeaderValue: str,

AddonInstanceTypeDef#

# AddonInstanceTypeDef definition

class AddonInstanceTypeDef(TypedDict):
    AddonInstanceArn: NotRequired[str],
    AddonInstanceId: NotRequired[str],
    AddonName: NotRequired[str],
    AddonSubscriptionId: NotRequired[str],
    CreatedTimestamp: NotRequired[datetime],

AddonSubscriptionTypeDef#

# AddonSubscriptionTypeDef definition

class AddonSubscriptionTypeDef(TypedDict):
    AddonName: NotRequired[str],
    AddonSubscriptionArn: NotRequired[str],
    AddonSubscriptionId: NotRequired[str],
    CreatedTimestamp: NotRequired[datetime],

AnalysisTypeDef#

# AnalysisTypeDef definition

class AnalysisTypeDef(TypedDict):
    Analyzer: str,
    ResultField: str,

ArchiveActionTypeDef#

# ArchiveActionTypeDef definition

class ArchiveActionTypeDef(TypedDict):
    TargetArchive: str,
    ActionFailurePolicy: NotRequired[ActionFailurePolicyType],  # (1)
  1. See ActionFailurePolicyType

ArchiveBooleanToEvaluateTypeDef#

# ArchiveBooleanToEvaluateTypeDef definition

class ArchiveBooleanToEvaluateTypeDef(TypedDict):
    Attribute: NotRequired[ArchiveBooleanEmailAttributeType],  # (1)
  1. See ArchiveBooleanEmailAttributeType

ArchiveRetentionTypeDef#

# ArchiveRetentionTypeDef definition

class ArchiveRetentionTypeDef(TypedDict):
    RetentionPeriod: NotRequired[RetentionPeriodType],  # (1)
  1. See RetentionPeriodType

ArchiveStringToEvaluateTypeDef#

# ArchiveStringToEvaluateTypeDef definition

class ArchiveStringToEvaluateTypeDef(TypedDict):
    Attribute: NotRequired[ArchiveStringEmailAttributeType],  # (1)
  1. See ArchiveStringEmailAttributeType

ArchiveTypeDef#

# ArchiveTypeDef definition

class ArchiveTypeDef(TypedDict):
    ArchiveId: str,
    ArchiveName: NotRequired[str],
    ArchiveState: NotRequired[ArchiveStateType],  # (1)
    LastUpdatedTimestamp: NotRequired[datetime],
  1. See ArchiveStateType

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

IngressPointConfigurationTypeDef#

# IngressPointConfigurationTypeDef definition

class IngressPointConfigurationTypeDef(TypedDict):
    SecretArn: NotRequired[str],
    SmtpPassword: NotRequired[str],

RelayAuthenticationTypeDef#

# RelayAuthenticationTypeDef definition

class RelayAuthenticationTypeDef(TypedDict):
    NoAuthentication: NotRequired[Mapping[str, Any]],
    SecretArn: NotRequired[str],

DeleteAddonInstanceRequestRequestTypeDef#

# DeleteAddonInstanceRequestRequestTypeDef definition

class DeleteAddonInstanceRequestRequestTypeDef(TypedDict):
    AddonInstanceId: str,

DeleteAddonSubscriptionRequestRequestTypeDef#

# DeleteAddonSubscriptionRequestRequestTypeDef definition

class DeleteAddonSubscriptionRequestRequestTypeDef(TypedDict):
    AddonSubscriptionId: str,

DeleteArchiveRequestRequestTypeDef#

# DeleteArchiveRequestRequestTypeDef definition

class DeleteArchiveRequestRequestTypeDef(TypedDict):
    ArchiveId: str,

DeleteIngressPointRequestRequestTypeDef#

# DeleteIngressPointRequestRequestTypeDef definition

class DeleteIngressPointRequestRequestTypeDef(TypedDict):
    IngressPointId: str,

DeleteRelayRequestRequestTypeDef#

# DeleteRelayRequestRequestTypeDef definition

class DeleteRelayRequestRequestTypeDef(TypedDict):
    RelayId: str,

DeleteRuleSetRequestRequestTypeDef#

# DeleteRuleSetRequestRequestTypeDef definition

class DeleteRuleSetRequestRequestTypeDef(TypedDict):
    RuleSetId: str,

DeleteTrafficPolicyRequestRequestTypeDef#

# DeleteTrafficPolicyRequestRequestTypeDef definition

class DeleteTrafficPolicyRequestRequestTypeDef(TypedDict):
    TrafficPolicyId: str,

DeliverToMailboxActionTypeDef#

# DeliverToMailboxActionTypeDef definition

class DeliverToMailboxActionTypeDef(TypedDict):
    MailboxArn: str,
    RoleArn: str,
    ActionFailurePolicy: NotRequired[ActionFailurePolicyType],  # (1)
  1. See ActionFailurePolicyType

DeliverToQBusinessActionTypeDef#

# DeliverToQBusinessActionTypeDef definition

class DeliverToQBusinessActionTypeDef(TypedDict):
    ApplicationId: str,
    IndexId: str,
    RoleArn: str,
    ActionFailurePolicy: NotRequired[ActionFailurePolicyType],  # (1)
  1. See ActionFailurePolicyType

EnvelopeTypeDef#

# EnvelopeTypeDef definition

class EnvelopeTypeDef(TypedDict):
    From: NotRequired[str],
    Helo: NotRequired[str],
    To: NotRequired[list[str]],

S3ExportDestinationConfigurationTypeDef#

# S3ExportDestinationConfigurationTypeDef definition

class S3ExportDestinationConfigurationTypeDef(TypedDict):
    S3Location: NotRequired[str],

ExportStatusTypeDef#

# ExportStatusTypeDef definition

class ExportStatusTypeDef(TypedDict):
    CompletionTimestamp: NotRequired[datetime],
    ErrorMessage: NotRequired[str],
    State: NotRequired[ExportStateType],  # (1)
    SubmissionTimestamp: NotRequired[datetime],
  1. See ExportStateType

GetAddonInstanceRequestRequestTypeDef#

# GetAddonInstanceRequestRequestTypeDef definition

class GetAddonInstanceRequestRequestTypeDef(TypedDict):
    AddonInstanceId: str,

GetAddonSubscriptionRequestRequestTypeDef#

# GetAddonSubscriptionRequestRequestTypeDef definition

class GetAddonSubscriptionRequestRequestTypeDef(TypedDict):
    AddonSubscriptionId: str,

GetArchiveExportRequestRequestTypeDef#

# GetArchiveExportRequestRequestTypeDef definition

class GetArchiveExportRequestRequestTypeDef(TypedDict):
    ExportId: str,

GetArchiveMessageContentRequestRequestTypeDef#

# GetArchiveMessageContentRequestRequestTypeDef definition

class GetArchiveMessageContentRequestRequestTypeDef(TypedDict):
    ArchivedMessageId: str,

MessageBodyTypeDef#

# MessageBodyTypeDef definition

class MessageBodyTypeDef(TypedDict):
    Html: NotRequired[str],
    MessageMalformed: NotRequired[bool],
    Text: NotRequired[str],

GetArchiveMessageRequestRequestTypeDef#

# GetArchiveMessageRequestRequestTypeDef definition

class GetArchiveMessageRequestRequestTypeDef(TypedDict):
    ArchivedMessageId: str,

MetadataTypeDef#

# MetadataTypeDef definition

class MetadataTypeDef(TypedDict):
    IngressPointId: NotRequired[str],
    RuleSetId: NotRequired[str],
    SenderHostname: NotRequired[str],
    SenderIpAddress: NotRequired[str],
    Timestamp: NotRequired[datetime],
    TlsCipherSuite: NotRequired[str],
    TlsProtocol: NotRequired[str],
    TrafficPolicyId: NotRequired[str],

GetArchiveRequestRequestTypeDef#

# GetArchiveRequestRequestTypeDef definition

class GetArchiveRequestRequestTypeDef(TypedDict):
    ArchiveId: str,

GetArchiveSearchRequestRequestTypeDef#

# GetArchiveSearchRequestRequestTypeDef definition

class GetArchiveSearchRequestRequestTypeDef(TypedDict):
    SearchId: str,

SearchStatusTypeDef#

# SearchStatusTypeDef definition

class SearchStatusTypeDef(TypedDict):
    CompletionTimestamp: NotRequired[datetime],
    ErrorMessage: NotRequired[str],
    State: NotRequired[SearchStateType],  # (1)
    SubmissionTimestamp: NotRequired[datetime],
  1. See SearchStateType

GetArchiveSearchResultsRequestRequestTypeDef#

# GetArchiveSearchResultsRequestRequestTypeDef definition

class GetArchiveSearchResultsRequestRequestTypeDef(TypedDict):
    SearchId: str,

GetIngressPointRequestRequestTypeDef#

# GetIngressPointRequestRequestTypeDef definition

class GetIngressPointRequestRequestTypeDef(TypedDict):
    IngressPointId: str,

GetRelayRequestRequestTypeDef#

# GetRelayRequestRequestTypeDef definition

class GetRelayRequestRequestTypeDef(TypedDict):
    RelayId: str,

RelayAuthenticationOutputTypeDef#

# RelayAuthenticationOutputTypeDef definition

class RelayAuthenticationOutputTypeDef(TypedDict):
    NoAuthentication: NotRequired[dict[str, Any]],
    SecretArn: NotRequired[str],

GetRuleSetRequestRequestTypeDef#

# GetRuleSetRequestRequestTypeDef definition

class GetRuleSetRequestRequestTypeDef(TypedDict):
    RuleSetId: str,

GetTrafficPolicyRequestRequestTypeDef#

# GetTrafficPolicyRequestRequestTypeDef definition

class GetTrafficPolicyRequestRequestTypeDef(TypedDict):
    TrafficPolicyId: str,

IngressAnalysisTypeDef#

# IngressAnalysisTypeDef definition

class IngressAnalysisTypeDef(TypedDict):
    Analyzer: str,
    ResultField: str,

IngressIpToEvaluateTypeDef#

# IngressIpToEvaluateTypeDef definition

class IngressIpToEvaluateTypeDef(TypedDict):
    Attribute: NotRequired[IngressIpv4AttributeType],  # (1)
  1. See IngressIpv4AttributeType

IngressPointPasswordConfigurationTypeDef#

# IngressPointPasswordConfigurationTypeDef definition

class IngressPointPasswordConfigurationTypeDef(TypedDict):
    PreviousSmtpPasswordExpiryTimestamp: NotRequired[datetime],
    PreviousSmtpPasswordVersion: NotRequired[str],
    SmtpPasswordVersion: NotRequired[str],

IngressPointTypeDef#

# IngressPointTypeDef definition

class IngressPointTypeDef(TypedDict):
    IngressPointId: str,
    IngressPointName: str,
    Status: IngressPointStatusType,  # (1)
    Type: IngressPointTypeType,  # (2)
    ARecord: NotRequired[str],
  1. See IngressPointStatusType
  2. See IngressPointTypeType

IngressStringToEvaluateTypeDef#

# IngressStringToEvaluateTypeDef definition

class IngressStringToEvaluateTypeDef(TypedDict):
    Attribute: NotRequired[IngressStringEmailAttributeType],  # (1)
  1. See IngressStringEmailAttributeType

IngressTlsProtocolToEvaluateTypeDef#

# IngressTlsProtocolToEvaluateTypeDef definition

class IngressTlsProtocolToEvaluateTypeDef(TypedDict):
    Attribute: NotRequired[IngressTlsAttributeType],  # (1)
  1. See IngressTlsAttributeType

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

ListAddonInstancesRequestRequestTypeDef#

# ListAddonInstancesRequestRequestTypeDef definition

class ListAddonInstancesRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    PageSize: NotRequired[int],

ListAddonSubscriptionsRequestRequestTypeDef#

# ListAddonSubscriptionsRequestRequestTypeDef definition

class ListAddonSubscriptionsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    PageSize: NotRequired[int],

ListArchiveExportsRequestRequestTypeDef#

# ListArchiveExportsRequestRequestTypeDef definition

class ListArchiveExportsRequestRequestTypeDef(TypedDict):
    ArchiveId: str,
    NextToken: NotRequired[str],
    PageSize: NotRequired[int],

ListArchiveSearchesRequestRequestTypeDef#

# ListArchiveSearchesRequestRequestTypeDef definition

class ListArchiveSearchesRequestRequestTypeDef(TypedDict):
    ArchiveId: str,
    NextToken: NotRequired[str],
    PageSize: NotRequired[int],

ListArchivesRequestRequestTypeDef#

# ListArchivesRequestRequestTypeDef definition

class ListArchivesRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    PageSize: NotRequired[int],

ListIngressPointsRequestRequestTypeDef#

# ListIngressPointsRequestRequestTypeDef definition

class ListIngressPointsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    PageSize: NotRequired[int],

ListRelaysRequestRequestTypeDef#

# ListRelaysRequestRequestTypeDef definition

class ListRelaysRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    PageSize: NotRequired[int],

RelayTypeDef#

# RelayTypeDef definition

class RelayTypeDef(TypedDict):
    LastModifiedTimestamp: NotRequired[datetime],
    RelayId: NotRequired[str],
    RelayName: NotRequired[str],

ListRuleSetsRequestRequestTypeDef#

# ListRuleSetsRequestRequestTypeDef definition

class ListRuleSetsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    PageSize: NotRequired[int],

RuleSetTypeDef#

# RuleSetTypeDef definition

class RuleSetTypeDef(TypedDict):
    LastModificationDate: NotRequired[datetime],
    RuleSetId: NotRequired[str],
    RuleSetName: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

ListTrafficPoliciesRequestRequestTypeDef#

# ListTrafficPoliciesRequestRequestTypeDef definition

class ListTrafficPoliciesRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    PageSize: NotRequired[int],

TrafficPolicyTypeDef#

# TrafficPolicyTypeDef definition

class TrafficPolicyTypeDef(TypedDict):
    DefaultAction: AcceptActionType,  # (1)
    TrafficPolicyId: str,
    TrafficPolicyName: str,
  1. See AcceptActionType

RelayActionTypeDef#

# RelayActionTypeDef definition

class RelayActionTypeDef(TypedDict):
    Relay: str,
    ActionFailurePolicy: NotRequired[ActionFailurePolicyType],  # (1)
    MailFrom: NotRequired[MailFromType],  # (2)
  1. See ActionFailurePolicyType
  2. See MailFromType

ReplaceRecipientActionOutputTypeDef#

# ReplaceRecipientActionOutputTypeDef definition

class ReplaceRecipientActionOutputTypeDef(TypedDict):
    ReplaceWith: NotRequired[list[str]],

ReplaceRecipientActionTypeDef#

# ReplaceRecipientActionTypeDef definition

class ReplaceRecipientActionTypeDef(TypedDict):
    ReplaceWith: NotRequired[Sequence[str]],

S3ActionTypeDef#

# S3ActionTypeDef definition

class S3ActionTypeDef(TypedDict):
    RoleArn: str,
    S3Bucket: str,
    ActionFailurePolicy: NotRequired[ActionFailurePolicyType],  # (1)
    S3Prefix: NotRequired[str],
    S3SseKmsKeyId: NotRequired[str],
  1. See ActionFailurePolicyType

SendActionTypeDef#

# SendActionTypeDef definition

class SendActionTypeDef(TypedDict):
    RoleArn: str,
    ActionFailurePolicy: NotRequired[ActionFailurePolicyType],  # (1)
  1. See ActionFailurePolicyType

RuleBooleanToEvaluateTypeDef#

# RuleBooleanToEvaluateTypeDef definition

class RuleBooleanToEvaluateTypeDef(TypedDict):
    Attribute: NotRequired[RuleBooleanEmailAttributeType],  # (1)
  1. See RuleBooleanEmailAttributeType

RuleDmarcExpressionOutputTypeDef#

# RuleDmarcExpressionOutputTypeDef definition

class RuleDmarcExpressionOutputTypeDef(TypedDict):
    Operator: RuleDmarcOperatorType,  # (1)
    Values: list[RuleDmarcPolicyType],  # (2)
  1. See RuleDmarcOperatorType
  2. See RuleDmarcPolicyType

RuleDmarcExpressionTypeDef#

# RuleDmarcExpressionTypeDef definition

class RuleDmarcExpressionTypeDef(TypedDict):
    Operator: RuleDmarcOperatorType,  # (1)
    Values: Sequence[RuleDmarcPolicyType],  # (2)
  1. See RuleDmarcOperatorType
  2. See RuleDmarcPolicyType

RuleIpToEvaluateTypeDef#

# RuleIpToEvaluateTypeDef definition

class RuleIpToEvaluateTypeDef(TypedDict):
    Attribute: NotRequired[RuleIpEmailAttributeType],  # (1)
  1. See RuleIpEmailAttributeType

RuleNumberToEvaluateTypeDef#

# RuleNumberToEvaluateTypeDef definition

class RuleNumberToEvaluateTypeDef(TypedDict):
    Attribute: NotRequired[RuleNumberEmailAttributeType],  # (1)
  1. See RuleNumberEmailAttributeType

RuleStringToEvaluateTypeDef#

# RuleStringToEvaluateTypeDef definition

class RuleStringToEvaluateTypeDef(TypedDict):
    Attribute: NotRequired[RuleStringEmailAttributeType],  # (1)
    MimeHeaderAttribute: NotRequired[str],
  1. See RuleStringEmailAttributeType

StopArchiveExportRequestRequestTypeDef#

# StopArchiveExportRequestRequestTypeDef definition

class StopArchiveExportRequestRequestTypeDef(TypedDict):
    ExportId: str,

StopArchiveSearchRequestRequestTypeDef#

# StopArchiveSearchRequestRequestTypeDef definition

class StopArchiveSearchRequestRequestTypeDef(TypedDict):
    SearchId: str,

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    TagKeys: Sequence[str],

RuleVerdictToEvaluateTypeDef#

# RuleVerdictToEvaluateTypeDef definition

class RuleVerdictToEvaluateTypeDef(TypedDict):
    Analysis: NotRequired[AnalysisTypeDef],  # (1)
    Attribute: NotRequired[RuleVerdictAttributeType],  # (2)
  1. See AnalysisTypeDef
  2. See RuleVerdictAttributeType

ArchiveBooleanExpressionTypeDef#

# ArchiveBooleanExpressionTypeDef definition

class ArchiveBooleanExpressionTypeDef(TypedDict):
    Evaluate: ArchiveBooleanToEvaluateTypeDef,  # (1)
    Operator: ArchiveBooleanOperatorType,  # (2)
  1. See ArchiveBooleanToEvaluateTypeDef
  2. See ArchiveBooleanOperatorType

UpdateArchiveRequestRequestTypeDef#

# UpdateArchiveRequestRequestTypeDef definition

class UpdateArchiveRequestRequestTypeDef(TypedDict):
    ArchiveId: str,
    ArchiveName: NotRequired[str],
    Retention: NotRequired[ArchiveRetentionTypeDef],  # (1)
  1. See ArchiveRetentionTypeDef

ArchiveStringExpressionOutputTypeDef#

# ArchiveStringExpressionOutputTypeDef definition

class ArchiveStringExpressionOutputTypeDef(TypedDict):
    Evaluate: ArchiveStringToEvaluateTypeDef,  # (1)
    Operator: ArchiveStringOperatorType,  # (2)
    Values: list[str],
  1. See ArchiveStringToEvaluateTypeDef
  2. See ArchiveStringOperatorType

ArchiveStringExpressionTypeDef#

# ArchiveStringExpressionTypeDef definition

class ArchiveStringExpressionTypeDef(TypedDict):
    Evaluate: ArchiveStringToEvaluateTypeDef,  # (1)
    Operator: ArchiveStringOperatorType,  # (2)
    Values: Sequence[str],
  1. See ArchiveStringToEvaluateTypeDef
  2. See ArchiveStringOperatorType

CreateAddonInstanceRequestRequestTypeDef#

# CreateAddonInstanceRequestRequestTypeDef definition

class CreateAddonInstanceRequestRequestTypeDef(TypedDict):
    AddonSubscriptionId: str,
    ClientToken: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

CreateAddonSubscriptionRequestRequestTypeDef#

# CreateAddonSubscriptionRequestRequestTypeDef definition

class CreateAddonSubscriptionRequestRequestTypeDef(TypedDict):
    AddonName: str,
    ClientToken: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

CreateArchiveRequestRequestTypeDef#

# CreateArchiveRequestRequestTypeDef definition

class CreateArchiveRequestRequestTypeDef(TypedDict):
    ArchiveName: str,
    ClientToken: NotRequired[str],
    KmsKeyArn: NotRequired[str],
    Retention: NotRequired[ArchiveRetentionTypeDef],  # (1)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See ArchiveRetentionTypeDef
  2. See TagTypeDef

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

CreateAddonInstanceResponseTypeDef#

# CreateAddonInstanceResponseTypeDef definition

class CreateAddonInstanceResponseTypeDef(TypedDict):
    AddonInstanceId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateAddonSubscriptionResponseTypeDef#

# CreateAddonSubscriptionResponseTypeDef definition

class CreateAddonSubscriptionResponseTypeDef(TypedDict):
    AddonSubscriptionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateArchiveResponseTypeDef#

# CreateArchiveResponseTypeDef definition

class CreateArchiveResponseTypeDef(TypedDict):
    ArchiveId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateIngressPointResponseTypeDef#

# CreateIngressPointResponseTypeDef definition

class CreateIngressPointResponseTypeDef(TypedDict):
    IngressPointId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateRelayResponseTypeDef#

# CreateRelayResponseTypeDef definition

class CreateRelayResponseTypeDef(TypedDict):
    RelayId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateRuleSetResponseTypeDef#

# CreateRuleSetResponseTypeDef definition

class CreateRuleSetResponseTypeDef(TypedDict):
    RuleSetId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateTrafficPolicyResponseTypeDef#

# CreateTrafficPolicyResponseTypeDef definition

class CreateTrafficPolicyResponseTypeDef(TypedDict):
    TrafficPolicyId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetAddonInstanceResponseTypeDef#

# GetAddonInstanceResponseTypeDef definition

class GetAddonInstanceResponseTypeDef(TypedDict):
    AddonInstanceArn: str,
    AddonName: str,
    AddonSubscriptionId: str,
    CreatedTimestamp: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetAddonSubscriptionResponseTypeDef#

# GetAddonSubscriptionResponseTypeDef definition

class GetAddonSubscriptionResponseTypeDef(TypedDict):
    AddonName: str,
    AddonSubscriptionArn: str,
    CreatedTimestamp: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetArchiveResponseTypeDef#

# GetArchiveResponseTypeDef definition

class GetArchiveResponseTypeDef(TypedDict):
    ArchiveArn: str,
    ArchiveId: str,
    ArchiveName: str,
    ArchiveState: ArchiveStateType,  # (1)
    CreatedTimestamp: datetime,
    KmsKeyArn: str,
    LastUpdatedTimestamp: datetime,
    Retention: ArchiveRetentionTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ArchiveStateType
  2. See ArchiveRetentionTypeDef
  3. See ResponseMetadataTypeDef

ListAddonInstancesResponseTypeDef#

# ListAddonInstancesResponseTypeDef definition

class ListAddonInstancesResponseTypeDef(TypedDict):
    AddonInstances: list[AddonInstanceTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See AddonInstanceTypeDef
  2. See ResponseMetadataTypeDef

ListAddonSubscriptionsResponseTypeDef#

# ListAddonSubscriptionsResponseTypeDef definition

class ListAddonSubscriptionsResponseTypeDef(TypedDict):
    AddonSubscriptions: list[AddonSubscriptionTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See AddonSubscriptionTypeDef
  2. See ResponseMetadataTypeDef

ListArchivesResponseTypeDef#

# ListArchivesResponseTypeDef definition

class ListArchivesResponseTypeDef(TypedDict):
    Archives: list[ArchiveTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ArchiveTypeDef
  2. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    Tags: list[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

StartArchiveExportResponseTypeDef#

# StartArchiveExportResponseTypeDef definition

class StartArchiveExportResponseTypeDef(TypedDict):
    ExportId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartArchiveSearchResponseTypeDef#

# StartArchiveSearchResponseTypeDef definition

class StartArchiveSearchResponseTypeDef(TypedDict):
    SearchId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateIngressPointRequestRequestTypeDef#

# CreateIngressPointRequestRequestTypeDef definition

class CreateIngressPointRequestRequestTypeDef(TypedDict):
    IngressPointName: str,
    RuleSetId: str,
    TrafficPolicyId: str,
    Type: IngressPointTypeType,  # (1)
    ClientToken: NotRequired[str],
    IngressPointConfiguration: NotRequired[IngressPointConfigurationTypeDef],  # (2)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (3)
  1. See IngressPointTypeType
  2. See IngressPointConfigurationTypeDef
  3. See TagTypeDef

UpdateIngressPointRequestRequestTypeDef#

# UpdateIngressPointRequestRequestTypeDef definition

class UpdateIngressPointRequestRequestTypeDef(TypedDict):
    IngressPointId: str,
    IngressPointConfiguration: NotRequired[IngressPointConfigurationTypeDef],  # (1)
    IngressPointName: NotRequired[str],
    RuleSetId: NotRequired[str],
    StatusToUpdate: NotRequired[IngressPointStatusToUpdateType],  # (2)
    TrafficPolicyId: NotRequired[str],
  1. See IngressPointConfigurationTypeDef
  2. See IngressPointStatusToUpdateType

CreateRelayRequestRequestTypeDef#

# CreateRelayRequestRequestTypeDef definition

class CreateRelayRequestRequestTypeDef(TypedDict):
    Authentication: RelayAuthenticationTypeDef,  # (1)
    RelayName: str,
    ServerName: str,
    ServerPort: int,
    ClientToken: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See RelayAuthenticationTypeDef
  2. See TagTypeDef

UpdateRelayRequestRequestTypeDef#

# UpdateRelayRequestRequestTypeDef definition

class UpdateRelayRequestRequestTypeDef(TypedDict):
    RelayId: str,
    Authentication: NotRequired[RelayAuthenticationTypeDef],  # (1)
    RelayName: NotRequired[str],
    ServerName: NotRequired[str],
    ServerPort: NotRequired[int],
  1. See RelayAuthenticationTypeDef

RowTypeDef#

# RowTypeDef definition

class RowTypeDef(TypedDict):
    ArchivedMessageId: NotRequired[str],
    Cc: NotRequired[str],
    Date: NotRequired[str],
    Envelope: NotRequired[EnvelopeTypeDef],  # (1)
    From: NotRequired[str],
    HasAttachments: NotRequired[bool],
    InReplyTo: NotRequired[str],
    IngressPointId: NotRequired[str],
    MessageId: NotRequired[str],
    ReceivedHeaders: NotRequired[list[str]],
    ReceivedTimestamp: NotRequired[datetime],
    SenderHostname: NotRequired[str],
    SenderIpAddress: NotRequired[str],
    Subject: NotRequired[str],
    To: NotRequired[str],
    XMailer: NotRequired[str],
    XOriginalMailer: NotRequired[str],
    XPriority: NotRequired[str],
  1. See EnvelopeTypeDef

ExportDestinationConfigurationTypeDef#

# ExportDestinationConfigurationTypeDef definition

class ExportDestinationConfigurationTypeDef(TypedDict):
    S3: NotRequired[S3ExportDestinationConfigurationTypeDef],  # (1)
  1. See S3ExportDestinationConfigurationTypeDef

ExportSummaryTypeDef#

# ExportSummaryTypeDef definition

class ExportSummaryTypeDef(TypedDict):
    ExportId: NotRequired[str],
    Status: NotRequired[ExportStatusTypeDef],  # (1)
  1. See ExportStatusTypeDef

GetArchiveMessageContentResponseTypeDef#

# GetArchiveMessageContentResponseTypeDef definition

class GetArchiveMessageContentResponseTypeDef(TypedDict):
    Body: MessageBodyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MessageBodyTypeDef
  2. See ResponseMetadataTypeDef

GetArchiveMessageResponseTypeDef#

# GetArchiveMessageResponseTypeDef definition

class GetArchiveMessageResponseTypeDef(TypedDict):
    Envelope: EnvelopeTypeDef,  # (1)
    MessageDownloadLink: str,
    Metadata: MetadataTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See EnvelopeTypeDef
  2. See MetadataTypeDef
  3. See ResponseMetadataTypeDef

SearchSummaryTypeDef#

# SearchSummaryTypeDef definition

class SearchSummaryTypeDef(TypedDict):
    SearchId: NotRequired[str],
    Status: NotRequired[SearchStatusTypeDef],  # (1)
  1. See SearchStatusTypeDef

GetRelayResponseTypeDef#

# GetRelayResponseTypeDef definition

class GetRelayResponseTypeDef(TypedDict):
    Authentication: RelayAuthenticationOutputTypeDef,  # (1)
    CreatedTimestamp: datetime,
    LastModifiedTimestamp: datetime,
    RelayArn: str,
    RelayId: str,
    RelayName: str,
    ServerName: str,
    ServerPort: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RelayAuthenticationOutputTypeDef
  2. See ResponseMetadataTypeDef

IngressBooleanToEvaluateTypeDef#

# IngressBooleanToEvaluateTypeDef definition

class IngressBooleanToEvaluateTypeDef(TypedDict):
    Analysis: NotRequired[IngressAnalysisTypeDef],  # (1)
  1. See IngressAnalysisTypeDef

IngressIpv4ExpressionOutputTypeDef#

# IngressIpv4ExpressionOutputTypeDef definition

class IngressIpv4ExpressionOutputTypeDef(TypedDict):
    Evaluate: IngressIpToEvaluateTypeDef,  # (1)
    Operator: IngressIpOperatorType,  # (2)
    Values: list[str],
  1. See IngressIpToEvaluateTypeDef
  2. See IngressIpOperatorType

IngressIpv4ExpressionTypeDef#

# IngressIpv4ExpressionTypeDef definition

class IngressIpv4ExpressionTypeDef(TypedDict):
    Evaluate: IngressIpToEvaluateTypeDef,  # (1)
    Operator: IngressIpOperatorType,  # (2)
    Values: Sequence[str],
  1. See IngressIpToEvaluateTypeDef
  2. See IngressIpOperatorType

IngressPointAuthConfigurationTypeDef#

# IngressPointAuthConfigurationTypeDef definition

class IngressPointAuthConfigurationTypeDef(TypedDict):
    IngressPointPasswordConfiguration: NotRequired[IngressPointPasswordConfigurationTypeDef],  # (1)
    SecretArn: NotRequired[str],
  1. See IngressPointPasswordConfigurationTypeDef

ListIngressPointsResponseTypeDef#

# ListIngressPointsResponseTypeDef definition

class ListIngressPointsResponseTypeDef(TypedDict):
    IngressPoints: list[IngressPointTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See IngressPointTypeDef
  2. See ResponseMetadataTypeDef

IngressStringExpressionOutputTypeDef#

# IngressStringExpressionOutputTypeDef definition

class IngressStringExpressionOutputTypeDef(TypedDict):
    Evaluate: IngressStringToEvaluateTypeDef,  # (1)
    Operator: IngressStringOperatorType,  # (2)
    Values: list[str],
  1. See IngressStringToEvaluateTypeDef
  2. See IngressStringOperatorType

IngressStringExpressionTypeDef#

# IngressStringExpressionTypeDef definition

class IngressStringExpressionTypeDef(TypedDict):
    Evaluate: IngressStringToEvaluateTypeDef,  # (1)
    Operator: IngressStringOperatorType,  # (2)
    Values: Sequence[str],
  1. See IngressStringToEvaluateTypeDef
  2. See IngressStringOperatorType

IngressTlsProtocolExpressionTypeDef#

# IngressTlsProtocolExpressionTypeDef definition

class IngressTlsProtocolExpressionTypeDef(TypedDict):
    Evaluate: IngressTlsProtocolToEvaluateTypeDef,  # (1)
    Operator: IngressTlsProtocolOperatorType,  # (2)
    Value: IngressTlsProtocolAttributeType,  # (3)
  1. See IngressTlsProtocolToEvaluateTypeDef
  2. See IngressTlsProtocolOperatorType
  3. See IngressTlsProtocolAttributeType

ListAddonInstancesRequestPaginateTypeDef#

# ListAddonInstancesRequestPaginateTypeDef definition

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

ListAddonSubscriptionsRequestPaginateTypeDef#

# ListAddonSubscriptionsRequestPaginateTypeDef definition

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

ListArchiveExportsRequestPaginateTypeDef#

# ListArchiveExportsRequestPaginateTypeDef definition

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

ListArchiveSearchesRequestPaginateTypeDef#

# ListArchiveSearchesRequestPaginateTypeDef definition

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

ListArchivesRequestPaginateTypeDef#

# ListArchivesRequestPaginateTypeDef definition

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

ListIngressPointsRequestPaginateTypeDef#

# ListIngressPointsRequestPaginateTypeDef definition

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

ListRelaysRequestPaginateTypeDef#

# ListRelaysRequestPaginateTypeDef definition

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

ListRuleSetsRequestPaginateTypeDef#

# ListRuleSetsRequestPaginateTypeDef definition

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

ListTrafficPoliciesRequestPaginateTypeDef#

# ListTrafficPoliciesRequestPaginateTypeDef definition

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

ListRelaysResponseTypeDef#

# ListRelaysResponseTypeDef definition

class ListRelaysResponseTypeDef(TypedDict):
    Relays: list[RelayTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See RelayTypeDef
  2. See ResponseMetadataTypeDef

ListRuleSetsResponseTypeDef#

# ListRuleSetsResponseTypeDef definition

class ListRuleSetsResponseTypeDef(TypedDict):
    RuleSets: list[RuleSetTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See RuleSetTypeDef
  2. See ResponseMetadataTypeDef

ListTrafficPoliciesResponseTypeDef#

# ListTrafficPoliciesResponseTypeDef definition

class ListTrafficPoliciesResponseTypeDef(TypedDict):
    TrafficPolicies: list[TrafficPolicyTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See TrafficPolicyTypeDef
  2. See ResponseMetadataTypeDef

RuleActionOutputTypeDef#

# RuleActionOutputTypeDef definition

class RuleActionOutputTypeDef(TypedDict):
    AddHeader: NotRequired[AddHeaderActionTypeDef],  # (1)
    Archive: NotRequired[ArchiveActionTypeDef],  # (2)
    DeliverToMailbox: NotRequired[DeliverToMailboxActionTypeDef],  # (3)
    DeliverToQBusiness: NotRequired[DeliverToQBusinessActionTypeDef],  # (4)
    Drop: NotRequired[dict[str, Any]],
    Relay: NotRequired[RelayActionTypeDef],  # (5)
    ReplaceRecipient: NotRequired[ReplaceRecipientActionOutputTypeDef],  # (6)
    Send: NotRequired[SendActionTypeDef],  # (7)
    WriteToS3: NotRequired[S3ActionTypeDef],  # (8)
  1. See AddHeaderActionTypeDef
  2. See ArchiveActionTypeDef
  3. See DeliverToMailboxActionTypeDef
  4. See DeliverToQBusinessActionTypeDef
  5. See RelayActionTypeDef
  6. See ReplaceRecipientActionOutputTypeDef
  7. See SendActionTypeDef
  8. See S3ActionTypeDef

RuleBooleanExpressionTypeDef#

# RuleBooleanExpressionTypeDef definition

class RuleBooleanExpressionTypeDef(TypedDict):
    Evaluate: RuleBooleanToEvaluateTypeDef,  # (1)
    Operator: RuleBooleanOperatorType,  # (2)
  1. See RuleBooleanToEvaluateTypeDef
  2. See RuleBooleanOperatorType

RuleIpExpressionOutputTypeDef#

# RuleIpExpressionOutputTypeDef definition

class RuleIpExpressionOutputTypeDef(TypedDict):
    Evaluate: RuleIpToEvaluateTypeDef,  # (1)
    Operator: RuleIpOperatorType,  # (2)
    Values: list[str],
  1. See RuleIpToEvaluateTypeDef
  2. See RuleIpOperatorType

RuleIpExpressionTypeDef#

# RuleIpExpressionTypeDef definition

class RuleIpExpressionTypeDef(TypedDict):
    Evaluate: RuleIpToEvaluateTypeDef,  # (1)
    Operator: RuleIpOperatorType,  # (2)
    Values: Sequence[str],
  1. See RuleIpToEvaluateTypeDef
  2. See RuleIpOperatorType

RuleNumberExpressionTypeDef#

# RuleNumberExpressionTypeDef definition

class RuleNumberExpressionTypeDef(TypedDict):
    Evaluate: RuleNumberToEvaluateTypeDef,  # (1)
    Operator: RuleNumberOperatorType,  # (2)
    Value: float,
  1. See RuleNumberToEvaluateTypeDef
  2. See RuleNumberOperatorType

RuleStringExpressionOutputTypeDef#

# RuleStringExpressionOutputTypeDef definition

class RuleStringExpressionOutputTypeDef(TypedDict):
    Evaluate: RuleStringToEvaluateTypeDef,  # (1)
    Operator: RuleStringOperatorType,  # (2)
    Values: list[str],
  1. See RuleStringToEvaluateTypeDef
  2. See RuleStringOperatorType

RuleStringExpressionTypeDef#

# RuleStringExpressionTypeDef definition

class RuleStringExpressionTypeDef(TypedDict):
    Evaluate: RuleStringToEvaluateTypeDef,  # (1)
    Operator: RuleStringOperatorType,  # (2)
    Values: Sequence[str],
  1. See RuleStringToEvaluateTypeDef
  2. See RuleStringOperatorType

RuleVerdictExpressionOutputTypeDef#

# RuleVerdictExpressionOutputTypeDef definition

class RuleVerdictExpressionOutputTypeDef(TypedDict):
    Evaluate: RuleVerdictToEvaluateTypeDef,  # (1)
    Operator: RuleVerdictOperatorType,  # (2)
    Values: list[RuleVerdictType],  # (3)
  1. See RuleVerdictToEvaluateTypeDef
  2. See RuleVerdictOperatorType
  3. See RuleVerdictType

RuleVerdictExpressionTypeDef#

# RuleVerdictExpressionTypeDef definition

class RuleVerdictExpressionTypeDef(TypedDict):
    Evaluate: RuleVerdictToEvaluateTypeDef,  # (1)
    Operator: RuleVerdictOperatorType,  # (2)
    Values: Sequence[RuleVerdictType],  # (3)
  1. See RuleVerdictToEvaluateTypeDef
  2. See RuleVerdictOperatorType
  3. See RuleVerdictType

ArchiveFilterConditionOutputTypeDef#

# ArchiveFilterConditionOutputTypeDef definition

class ArchiveFilterConditionOutputTypeDef(TypedDict):
    BooleanExpression: NotRequired[ArchiveBooleanExpressionTypeDef],  # (1)
    StringExpression: NotRequired[ArchiveStringExpressionOutputTypeDef],  # (2)
  1. See ArchiveBooleanExpressionTypeDef
  2. See ArchiveStringExpressionOutputTypeDef

GetArchiveSearchResultsResponseTypeDef#

# GetArchiveSearchResultsResponseTypeDef definition

class GetArchiveSearchResultsResponseTypeDef(TypedDict):
    Rows: list[RowTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RowTypeDef
  2. See ResponseMetadataTypeDef

ListArchiveExportsResponseTypeDef#

# ListArchiveExportsResponseTypeDef definition

class ListArchiveExportsResponseTypeDef(TypedDict):
    Exports: list[ExportSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ExportSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListArchiveSearchesResponseTypeDef#

# ListArchiveSearchesResponseTypeDef definition

class ListArchiveSearchesResponseTypeDef(TypedDict):
    Searches: list[SearchSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See SearchSummaryTypeDef
  2. See ResponseMetadataTypeDef

IngressBooleanExpressionTypeDef#

# IngressBooleanExpressionTypeDef definition

class IngressBooleanExpressionTypeDef(TypedDict):
    Evaluate: IngressBooleanToEvaluateTypeDef,  # (1)
    Operator: IngressBooleanOperatorType,  # (2)
  1. See IngressBooleanToEvaluateTypeDef
  2. See IngressBooleanOperatorType

GetIngressPointResponseTypeDef#

# GetIngressPointResponseTypeDef definition

class GetIngressPointResponseTypeDef(TypedDict):
    ARecord: str,
    CreatedTimestamp: datetime,
    IngressPointArn: str,
    IngressPointAuthConfiguration: IngressPointAuthConfigurationTypeDef,  # (1)
    IngressPointId: str,
    IngressPointName: str,
    LastUpdatedTimestamp: datetime,
    RuleSetId: str,
    Status: IngressPointStatusType,  # (2)
    TrafficPolicyId: str,
    Type: IngressPointTypeType,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See IngressPointAuthConfigurationTypeDef
  2. See IngressPointStatusType
  3. See IngressPointTypeType
  4. See ResponseMetadataTypeDef

RuleActionTypeDef#

# RuleActionTypeDef definition

class RuleActionTypeDef(TypedDict):
    AddHeader: NotRequired[AddHeaderActionTypeDef],  # (1)
    Archive: NotRequired[ArchiveActionTypeDef],  # (2)
    DeliverToMailbox: NotRequired[DeliverToMailboxActionTypeDef],  # (3)
    DeliverToQBusiness: NotRequired[DeliverToQBusinessActionTypeDef],  # (4)
    Drop: NotRequired[Mapping[str, Any]],
    Relay: NotRequired[RelayActionTypeDef],  # (5)
    ReplaceRecipient: NotRequired[ReplaceRecipientActionUnionTypeDef],  # (6)
    Send: NotRequired[SendActionTypeDef],  # (7)
    WriteToS3: NotRequired[S3ActionTypeDef],  # (8)
  1. See AddHeaderActionTypeDef
  2. See ArchiveActionTypeDef
  3. See DeliverToMailboxActionTypeDef
  4. See DeliverToQBusinessActionTypeDef
  5. See RelayActionTypeDef
  6. See ReplaceRecipientActionTypeDef ReplaceRecipientActionOutputTypeDef
  7. See SendActionTypeDef
  8. See S3ActionTypeDef

RuleConditionOutputTypeDef#

# RuleConditionOutputTypeDef definition

class RuleConditionOutputTypeDef(TypedDict):
    BooleanExpression: NotRequired[RuleBooleanExpressionTypeDef],  # (1)
    DmarcExpression: NotRequired[RuleDmarcExpressionOutputTypeDef],  # (2)
    IpExpression: NotRequired[RuleIpExpressionOutputTypeDef],  # (3)
    NumberExpression: NotRequired[RuleNumberExpressionTypeDef],  # (4)
    StringExpression: NotRequired[RuleStringExpressionOutputTypeDef],  # (5)
    VerdictExpression: NotRequired[RuleVerdictExpressionOutputTypeDef],  # (6)
  1. See RuleBooleanExpressionTypeDef
  2. See RuleDmarcExpressionOutputTypeDef
  3. See RuleIpExpressionOutputTypeDef
  4. See RuleNumberExpressionTypeDef
  5. See RuleStringExpressionOutputTypeDef
  6. See RuleVerdictExpressionOutputTypeDef

ArchiveFiltersOutputTypeDef#

# ArchiveFiltersOutputTypeDef definition

class ArchiveFiltersOutputTypeDef(TypedDict):
    Include: NotRequired[list[ArchiveFilterConditionOutputTypeDef]],  # (1)
    Unless: NotRequired[list[ArchiveFilterConditionOutputTypeDef]],  # (1)
  1. See ArchiveFilterConditionOutputTypeDef
  2. See ArchiveFilterConditionOutputTypeDef

ArchiveFilterConditionTypeDef#

# ArchiveFilterConditionTypeDef definition

class ArchiveFilterConditionTypeDef(TypedDict):
    BooleanExpression: NotRequired[ArchiveBooleanExpressionTypeDef],  # (1)
    StringExpression: NotRequired[ArchiveStringExpressionUnionTypeDef],  # (2)
  1. See ArchiveBooleanExpressionTypeDef
  2. See ArchiveStringExpressionTypeDef ArchiveStringExpressionOutputTypeDef

PolicyConditionOutputTypeDef#

# PolicyConditionOutputTypeDef definition

class PolicyConditionOutputTypeDef(TypedDict):
    BooleanExpression: NotRequired[IngressBooleanExpressionTypeDef],  # (1)
    IpExpression: NotRequired[IngressIpv4ExpressionOutputTypeDef],  # (2)
    StringExpression: NotRequired[IngressStringExpressionOutputTypeDef],  # (3)
    TlsExpression: NotRequired[IngressTlsProtocolExpressionTypeDef],  # (4)
  1. See IngressBooleanExpressionTypeDef
  2. See IngressIpv4ExpressionOutputTypeDef
  3. See IngressStringExpressionOutputTypeDef
  4. See IngressTlsProtocolExpressionTypeDef

PolicyConditionTypeDef#

# PolicyConditionTypeDef definition

class PolicyConditionTypeDef(TypedDict):
    BooleanExpression: NotRequired[IngressBooleanExpressionTypeDef],  # (1)
    IpExpression: NotRequired[IngressIpv4ExpressionUnionTypeDef],  # (2)
    StringExpression: NotRequired[IngressStringExpressionUnionTypeDef],  # (3)
    TlsExpression: NotRequired[IngressTlsProtocolExpressionTypeDef],  # (4)
  1. See IngressBooleanExpressionTypeDef
  2. See IngressIpv4ExpressionTypeDef IngressIpv4ExpressionOutputTypeDef
  3. See IngressStringExpressionTypeDef IngressStringExpressionOutputTypeDef
  4. See IngressTlsProtocolExpressionTypeDef

RuleOutputTypeDef#

# RuleOutputTypeDef definition

class RuleOutputTypeDef(TypedDict):
    Actions: list[RuleActionOutputTypeDef],  # (1)
    Conditions: NotRequired[list[RuleConditionOutputTypeDef]],  # (2)
    Name: NotRequired[str],
    Unless: NotRequired[list[RuleConditionOutputTypeDef]],  # (2)
  1. See RuleActionOutputTypeDef
  2. See RuleConditionOutputTypeDef
  3. See RuleConditionOutputTypeDef

RuleConditionTypeDef#

# RuleConditionTypeDef definition

class RuleConditionTypeDef(TypedDict):
    BooleanExpression: NotRequired[RuleBooleanExpressionTypeDef],  # (1)
    DmarcExpression: NotRequired[RuleDmarcExpressionUnionTypeDef],  # (2)
    IpExpression: NotRequired[RuleIpExpressionUnionTypeDef],  # (3)
    NumberExpression: NotRequired[RuleNumberExpressionTypeDef],  # (4)
    StringExpression: NotRequired[RuleStringExpressionUnionTypeDef],  # (5)
    VerdictExpression: NotRequired[RuleVerdictExpressionUnionTypeDef],  # (6)
  1. See RuleBooleanExpressionTypeDef
  2. See RuleDmarcExpressionTypeDef RuleDmarcExpressionOutputTypeDef
  3. See RuleIpExpressionTypeDef RuleIpExpressionOutputTypeDef
  4. See RuleNumberExpressionTypeDef
  5. See RuleStringExpressionTypeDef RuleStringExpressionOutputTypeDef
  6. See RuleVerdictExpressionTypeDef RuleVerdictExpressionOutputTypeDef

GetArchiveExportResponseTypeDef#

# GetArchiveExportResponseTypeDef definition

class GetArchiveExportResponseTypeDef(TypedDict):
    ArchiveId: str,
    ExportDestinationConfiguration: ExportDestinationConfigurationTypeDef,  # (1)
    Filters: ArchiveFiltersOutputTypeDef,  # (2)
    FromTimestamp: datetime,
    MaxResults: int,
    Status: ExportStatusTypeDef,  # (3)
    ToTimestamp: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See ExportDestinationConfigurationTypeDef
  2. See ArchiveFiltersOutputTypeDef
  3. See ExportStatusTypeDef
  4. See ResponseMetadataTypeDef

GetArchiveSearchResponseTypeDef#

# GetArchiveSearchResponseTypeDef definition

class GetArchiveSearchResponseTypeDef(TypedDict):
    ArchiveId: str,
    Filters: ArchiveFiltersOutputTypeDef,  # (1)
    FromTimestamp: datetime,
    MaxResults: int,
    Status: SearchStatusTypeDef,  # (2)
    ToTimestamp: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ArchiveFiltersOutputTypeDef
  2. See SearchStatusTypeDef
  3. See ResponseMetadataTypeDef

PolicyStatementOutputTypeDef#

# PolicyStatementOutputTypeDef definition

class PolicyStatementOutputTypeDef(TypedDict):
    Action: AcceptActionType,  # (1)
    Conditions: list[PolicyConditionOutputTypeDef],  # (2)
  1. See AcceptActionType
  2. See PolicyConditionOutputTypeDef

GetRuleSetResponseTypeDef#

# GetRuleSetResponseTypeDef definition

class GetRuleSetResponseTypeDef(TypedDict):
    CreatedDate: datetime,
    LastModificationDate: datetime,
    RuleSetArn: str,
    RuleSetId: str,
    RuleSetName: str,
    Rules: list[RuleOutputTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RuleOutputTypeDef
  2. See ResponseMetadataTypeDef

ArchiveFiltersTypeDef#

# ArchiveFiltersTypeDef definition

class ArchiveFiltersTypeDef(TypedDict):
    Include: NotRequired[Sequence[ArchiveFilterConditionUnionTypeDef]],  # (1)
    Unless: NotRequired[Sequence[ArchiveFilterConditionTypeDef]],  # (2)
  1. See ArchiveFilterConditionTypeDef ArchiveFilterConditionOutputTypeDef
  2. See ArchiveFilterConditionTypeDef

GetTrafficPolicyResponseTypeDef#

# GetTrafficPolicyResponseTypeDef definition

class GetTrafficPolicyResponseTypeDef(TypedDict):
    CreatedTimestamp: datetime,
    DefaultAction: AcceptActionType,  # (1)
    LastUpdatedTimestamp: datetime,
    MaxMessageSizeBytes: int,
    PolicyStatements: list[PolicyStatementOutputTypeDef],  # (2)
    TrafficPolicyArn: str,
    TrafficPolicyId: str,
    TrafficPolicyName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See AcceptActionType
  2. See PolicyStatementOutputTypeDef
  3. See ResponseMetadataTypeDef

PolicyStatementTypeDef#

# PolicyStatementTypeDef definition

class PolicyStatementTypeDef(TypedDict):
    Action: AcceptActionType,  # (1)
    Conditions: Sequence[PolicyConditionUnionTypeDef],  # (2)
  1. See AcceptActionType
  2. See PolicyConditionTypeDef PolicyConditionOutputTypeDef

RuleTypeDef#

# RuleTypeDef definition

class RuleTypeDef(TypedDict):
    Actions: Sequence[RuleActionUnionTypeDef],  # (1)
    Conditions: NotRequired[Sequence[RuleConditionUnionTypeDef]],  # (2)
    Name: NotRequired[str],
    Unless: NotRequired[Sequence[RuleConditionTypeDef]],  # (3)
  1. See RuleActionTypeDef RuleActionOutputTypeDef
  2. See RuleConditionTypeDef RuleConditionOutputTypeDef
  3. See RuleConditionTypeDef

StartArchiveExportRequestRequestTypeDef#

# StartArchiveExportRequestRequestTypeDef definition

class StartArchiveExportRequestRequestTypeDef(TypedDict):
    ArchiveId: str,
    ExportDestinationConfiguration: ExportDestinationConfigurationTypeDef,  # (1)
    FromTimestamp: TimestampTypeDef,
    ToTimestamp: TimestampTypeDef,
    Filters: NotRequired[ArchiveFiltersTypeDef],  # (2)
    IncludeMetadata: NotRequired[bool],
    MaxResults: NotRequired[int],
  1. See ExportDestinationConfigurationTypeDef
  2. See ArchiveFiltersTypeDef

StartArchiveSearchRequestRequestTypeDef#

# StartArchiveSearchRequestRequestTypeDef definition

class StartArchiveSearchRequestRequestTypeDef(TypedDict):
    ArchiveId: str,
    FromTimestamp: TimestampTypeDef,
    MaxResults: int,
    ToTimestamp: TimestampTypeDef,
    Filters: NotRequired[ArchiveFiltersTypeDef],  # (1)
  1. See ArchiveFiltersTypeDef

UpdateTrafficPolicyRequestRequestTypeDef#

# UpdateTrafficPolicyRequestRequestTypeDef definition

class UpdateTrafficPolicyRequestRequestTypeDef(TypedDict):
    TrafficPolicyId: str,
    DefaultAction: NotRequired[AcceptActionType],  # (1)
    MaxMessageSizeBytes: NotRequired[int],
    PolicyStatements: NotRequired[Sequence[PolicyStatementTypeDef]],  # (2)
    TrafficPolicyName: NotRequired[str],
  1. See AcceptActionType
  2. See PolicyStatementTypeDef

UpdateRuleSetRequestRequestTypeDef#

# UpdateRuleSetRequestRequestTypeDef definition

class UpdateRuleSetRequestRequestTypeDef(TypedDict):
    RuleSetId: str,
    RuleSetName: NotRequired[str],
    Rules: NotRequired[Sequence[RuleTypeDef]],  # (1)
  1. See RuleTypeDef

CreateTrafficPolicyRequestRequestTypeDef#

# CreateTrafficPolicyRequestRequestTypeDef definition

class CreateTrafficPolicyRequestRequestTypeDef(TypedDict):
    DefaultAction: AcceptActionType,  # (1)
    PolicyStatements: Sequence[PolicyStatementUnionTypeDef],  # (2)
    TrafficPolicyName: str,
    ClientToken: NotRequired[str],
    MaxMessageSizeBytes: NotRequired[int],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (3)
  1. See AcceptActionType
  2. See PolicyStatementTypeDef PolicyStatementOutputTypeDef
  3. See TagTypeDef

CreateRuleSetRequestRequestTypeDef#

# CreateRuleSetRequestRequestTypeDef definition

class CreateRuleSetRequestRequestTypeDef(TypedDict):
    RuleSetName: str,
    Rules: Sequence[RuleUnionTypeDef],  # (1)
    ClientToken: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See RuleTypeDef RuleOutputTypeDef
  2. See TagTypeDef