Skip to content

Type definitions#

Index > ElasticBeanstalk > Type definitions

Auto-generated documentation for ElasticBeanstalk type annotations stubs module mypy-boto3-elasticbeanstalk.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

AbortEnvironmentUpdateMessageRequestTypeDef#

# AbortEnvironmentUpdateMessageRequestTypeDef definition

class AbortEnvironmentUpdateMessageRequestTypeDef(TypedDict):
    EnvironmentId: NotRequired[str],
    EnvironmentName: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

LatencyTypeDef#

# LatencyTypeDef definition

class LatencyTypeDef(TypedDict):
    P999: NotRequired[float],
    P99: NotRequired[float],
    P95: NotRequired[float],
    P90: NotRequired[float],
    P85: NotRequired[float],
    P75: NotRequired[float],
    P50: NotRequired[float],
    P10: NotRequired[float],

StatusCodesTypeDef#

# StatusCodesTypeDef definition

class StatusCodesTypeDef(TypedDict):
    Status2xx: NotRequired[int],
    Status3xx: NotRequired[int],
    Status4xx: NotRequired[int],
    Status5xx: NotRequired[int],

S3LocationTypeDef#

# S3LocationTypeDef definition

class S3LocationTypeDef(TypedDict):
    S3Bucket: NotRequired[str],
    S3Key: NotRequired[str],

SourceBuildInformationTypeDef#

# SourceBuildInformationTypeDef definition

class SourceBuildInformationTypeDef(TypedDict):
    SourceType: SourceTypeType,  # (1)
    SourceRepository: SourceRepositoryType,  # (2)
    SourceLocation: str,
  1. See SourceTypeType
  2. See SourceRepositoryType

MaxAgeRuleTypeDef#

# MaxAgeRuleTypeDef definition

class MaxAgeRuleTypeDef(TypedDict):
    Enabled: bool,
    MaxAgeInDays: NotRequired[int],
    DeleteSourceFromS3: NotRequired[bool],

MaxCountRuleTypeDef#

# MaxCountRuleTypeDef definition

class MaxCountRuleTypeDef(TypedDict):
    Enabled: bool,
    MaxCount: NotRequired[int],
    DeleteSourceFromS3: NotRequired[bool],

ApplyEnvironmentManagedActionRequestRequestTypeDef#

# ApplyEnvironmentManagedActionRequestRequestTypeDef definition

class ApplyEnvironmentManagedActionRequestRequestTypeDef(TypedDict):
    ActionId: str,
    EnvironmentName: NotRequired[str],
    EnvironmentId: NotRequired[str],

AssociateEnvironmentOperationsRoleMessageRequestTypeDef#

# AssociateEnvironmentOperationsRoleMessageRequestTypeDef definition

class AssociateEnvironmentOperationsRoleMessageRequestTypeDef(TypedDict):
    EnvironmentName: str,
    OperationsRole: str,

AutoScalingGroupTypeDef#

# AutoScalingGroupTypeDef definition

class AutoScalingGroupTypeDef(TypedDict):
    Name: NotRequired[str],

BuildConfigurationTypeDef#

# BuildConfigurationTypeDef definition

class BuildConfigurationTypeDef(TypedDict):
    CodeBuildServiceRole: str,
    Image: str,
    ArtifactName: NotRequired[str],
    ComputeType: NotRequired[ComputeTypeType],  # (1)
    TimeoutInMinutes: NotRequired[int],
  1. See ComputeTypeType

BuilderTypeDef#

# BuilderTypeDef definition

class BuilderTypeDef(TypedDict):
    ARN: NotRequired[str],

CPUUtilizationTypeDef#

# CPUUtilizationTypeDef definition

class CPUUtilizationTypeDef(TypedDict):
    User: NotRequired[float],
    Nice: NotRequired[float],
    System: NotRequired[float],
    Idle: NotRequired[float],
    IOWait: NotRequired[float],
    IRQ: NotRequired[float],
    SoftIRQ: NotRequired[float],
    Privileged: NotRequired[float],

CheckDNSAvailabilityMessageRequestTypeDef#

# CheckDNSAvailabilityMessageRequestTypeDef definition

class CheckDNSAvailabilityMessageRequestTypeDef(TypedDict):
    CNAMEPrefix: str,

ComposeEnvironmentsMessageRequestTypeDef#

# ComposeEnvironmentsMessageRequestTypeDef definition

class ComposeEnvironmentsMessageRequestTypeDef(TypedDict):
    ApplicationName: NotRequired[str],
    GroupName: NotRequired[str],
    VersionLabels: NotRequired[Sequence[str]],

OptionRestrictionRegexTypeDef#

# OptionRestrictionRegexTypeDef definition

class OptionRestrictionRegexTypeDef(TypedDict):
    Pattern: NotRequired[str],
    Label: NotRequired[str],

ConfigurationOptionSettingTypeDef#

# ConfigurationOptionSettingTypeDef definition

class ConfigurationOptionSettingTypeDef(TypedDict):
    ResourceName: NotRequired[str],
    Namespace: NotRequired[str],
    OptionName: NotRequired[str],
    Value: NotRequired[str],

ValidationMessageTypeDef#

# ValidationMessageTypeDef definition

class ValidationMessageTypeDef(TypedDict):
    Message: NotRequired[str],
    Severity: NotRequired[ValidationSeverityType],  # (1)
    Namespace: NotRequired[str],
    OptionName: NotRequired[str],
  1. See ValidationSeverityType

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: NotRequired[str],
    Value: NotRequired[str],

SourceConfigurationTypeDef#

# SourceConfigurationTypeDef definition

class SourceConfigurationTypeDef(TypedDict):
    ApplicationName: NotRequired[str],
    TemplateName: NotRequired[str],

EnvironmentTierTypeDef#

# EnvironmentTierTypeDef definition

class EnvironmentTierTypeDef(TypedDict):
    Name: NotRequired[str],
    Type: NotRequired[str],
    Version: NotRequired[str],

OptionSpecificationTypeDef#

# OptionSpecificationTypeDef definition

class OptionSpecificationTypeDef(TypedDict):
    ResourceName: NotRequired[str],
    Namespace: NotRequired[str],
    OptionName: NotRequired[str],

PlatformSummaryTypeDef#

# PlatformSummaryTypeDef definition

class PlatformSummaryTypeDef(TypedDict):
    PlatformArn: NotRequired[str],
    PlatformOwner: NotRequired[str],
    PlatformStatus: NotRequired[PlatformStatusType],  # (1)
    PlatformCategory: NotRequired[str],
    OperatingSystemName: NotRequired[str],
    OperatingSystemVersion: NotRequired[str],
    SupportedTierList: NotRequired[List[str]],
    SupportedAddonList: NotRequired[List[str]],
    PlatformLifecycleState: NotRequired[str],
    PlatformVersion: NotRequired[str],
    PlatformBranchName: NotRequired[str],
    PlatformBranchLifecycleState: NotRequired[str],
  1. See PlatformStatusType

CustomAmiTypeDef#

# CustomAmiTypeDef definition

class CustomAmiTypeDef(TypedDict):
    VirtualizationType: NotRequired[str],
    ImageId: NotRequired[str],

DeleteApplicationMessageRequestTypeDef#

# DeleteApplicationMessageRequestTypeDef definition

class DeleteApplicationMessageRequestTypeDef(TypedDict):
    ApplicationName: str,
    TerminateEnvByForce: NotRequired[bool],

DeleteApplicationVersionMessageRequestTypeDef#

# DeleteApplicationVersionMessageRequestTypeDef definition

class DeleteApplicationVersionMessageRequestTypeDef(TypedDict):
    ApplicationName: str,
    VersionLabel: str,
    DeleteSourceBundle: NotRequired[bool],

DeleteConfigurationTemplateMessageRequestTypeDef#

# DeleteConfigurationTemplateMessageRequestTypeDef definition

class DeleteConfigurationTemplateMessageRequestTypeDef(TypedDict):
    ApplicationName: str,
    TemplateName: str,

DeleteEnvironmentConfigurationMessageRequestTypeDef#

# DeleteEnvironmentConfigurationMessageRequestTypeDef definition

class DeleteEnvironmentConfigurationMessageRequestTypeDef(TypedDict):
    ApplicationName: str,
    EnvironmentName: str,

DeletePlatformVersionRequestRequestTypeDef#

# DeletePlatformVersionRequestRequestTypeDef definition

class DeletePlatformVersionRequestRequestTypeDef(TypedDict):
    PlatformArn: NotRequired[str],

DeploymentTypeDef#

# DeploymentTypeDef definition

class DeploymentTypeDef(TypedDict):
    VersionLabel: NotRequired[str],
    DeploymentId: NotRequired[int],
    Status: NotRequired[str],
    DeploymentTime: NotRequired[datetime],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

DescribeApplicationVersionsMessageRequestTypeDef#

# DescribeApplicationVersionsMessageRequestTypeDef definition

class DescribeApplicationVersionsMessageRequestTypeDef(TypedDict):
    ApplicationName: NotRequired[str],
    VersionLabels: NotRequired[Sequence[str]],
    MaxRecords: NotRequired[int],
    NextToken: NotRequired[str],

DescribeApplicationsMessageRequestTypeDef#

# DescribeApplicationsMessageRequestTypeDef definition

class DescribeApplicationsMessageRequestTypeDef(TypedDict):
    ApplicationNames: NotRequired[Sequence[str]],

DescribeConfigurationSettingsMessageRequestTypeDef#

# DescribeConfigurationSettingsMessageRequestTypeDef definition

class DescribeConfigurationSettingsMessageRequestTypeDef(TypedDict):
    ApplicationName: str,
    TemplateName: NotRequired[str],
    EnvironmentName: NotRequired[str],

DescribeEnvironmentHealthRequestRequestTypeDef#

# DescribeEnvironmentHealthRequestRequestTypeDef definition

class DescribeEnvironmentHealthRequestRequestTypeDef(TypedDict):
    EnvironmentName: NotRequired[str],
    EnvironmentId: NotRequired[str],
    AttributeNames: NotRequired[Sequence[EnvironmentHealthAttributeType]],  # (1)
  1. See EnvironmentHealthAttributeType

InstanceHealthSummaryTypeDef#

# InstanceHealthSummaryTypeDef definition

class InstanceHealthSummaryTypeDef(TypedDict):
    NoData: NotRequired[int],
    Unknown: NotRequired[int],
    Pending: NotRequired[int],
    Ok: NotRequired[int],
    Info: NotRequired[int],
    Warning: NotRequired[int],
    Degraded: NotRequired[int],
    Severe: NotRequired[int],

DescribeEnvironmentManagedActionHistoryRequestRequestTypeDef#

# DescribeEnvironmentManagedActionHistoryRequestRequestTypeDef definition

class DescribeEnvironmentManagedActionHistoryRequestRequestTypeDef(TypedDict):
    EnvironmentId: NotRequired[str],
    EnvironmentName: NotRequired[str],
    NextToken: NotRequired[str],
    MaxItems: NotRequired[int],

ManagedActionHistoryItemTypeDef#

# ManagedActionHistoryItemTypeDef definition

class ManagedActionHistoryItemTypeDef(TypedDict):
    ActionId: NotRequired[str],
    ActionType: NotRequired[ActionTypeType],  # (1)
    ActionDescription: NotRequired[str],
    FailureType: NotRequired[FailureTypeType],  # (2)
    Status: NotRequired[ActionHistoryStatusType],  # (3)
    FailureDescription: NotRequired[str],
    ExecutedTime: NotRequired[datetime],
    FinishedTime: NotRequired[datetime],
  1. See ActionTypeType
  2. See FailureTypeType
  3. See ActionHistoryStatusType

DescribeEnvironmentManagedActionsRequestRequestTypeDef#

# DescribeEnvironmentManagedActionsRequestRequestTypeDef definition

class DescribeEnvironmentManagedActionsRequestRequestTypeDef(TypedDict):
    EnvironmentName: NotRequired[str],
    EnvironmentId: NotRequired[str],
    Status: NotRequired[ActionStatusType],  # (1)
  1. See ActionStatusType

ManagedActionTypeDef#

# ManagedActionTypeDef definition

class ManagedActionTypeDef(TypedDict):
    ActionId: NotRequired[str],
    ActionDescription: NotRequired[str],
    ActionType: NotRequired[ActionTypeType],  # (1)
    Status: NotRequired[ActionStatusType],  # (2)
    WindowStartTime: NotRequired[datetime],
  1. See ActionTypeType
  2. See ActionStatusType

DescribeEnvironmentResourcesMessageRequestTypeDef#

# DescribeEnvironmentResourcesMessageRequestTypeDef definition

class DescribeEnvironmentResourcesMessageRequestTypeDef(TypedDict):
    EnvironmentId: NotRequired[str],
    EnvironmentName: NotRequired[str],

WaiterConfigTypeDef#

# WaiterConfigTypeDef definition

class WaiterConfigTypeDef(TypedDict):
    Delay: NotRequired[int],
    MaxAttempts: NotRequired[int],

DescribeInstancesHealthRequestRequestTypeDef#

# DescribeInstancesHealthRequestRequestTypeDef definition

class DescribeInstancesHealthRequestRequestTypeDef(TypedDict):
    EnvironmentName: NotRequired[str],
    EnvironmentId: NotRequired[str],
    AttributeNames: NotRequired[Sequence[InstancesHealthAttributeType]],  # (1)
    NextToken: NotRequired[str],
  1. See InstancesHealthAttributeType

DescribePlatformVersionRequestRequestTypeDef#

# DescribePlatformVersionRequestRequestTypeDef definition

class DescribePlatformVersionRequestRequestTypeDef(TypedDict):
    PlatformArn: NotRequired[str],

DisassociateEnvironmentOperationsRoleMessageRequestTypeDef#

# DisassociateEnvironmentOperationsRoleMessageRequestTypeDef definition

class DisassociateEnvironmentOperationsRoleMessageRequestTypeDef(TypedDict):
    EnvironmentName: str,

EnvironmentLinkTypeDef#

# EnvironmentLinkTypeDef definition

class EnvironmentLinkTypeDef(TypedDict):
    LinkName: NotRequired[str],
    EnvironmentName: NotRequired[str],

EnvironmentInfoDescriptionTypeDef#

# EnvironmentInfoDescriptionTypeDef definition

class EnvironmentInfoDescriptionTypeDef(TypedDict):
    InfoType: NotRequired[EnvironmentInfoTypeType],  # (1)
    Ec2InstanceId: NotRequired[str],
    SampleTimestamp: NotRequired[datetime],
    Message: NotRequired[str],
  1. See EnvironmentInfoTypeType

InstanceTypeDef#

# InstanceTypeDef definition

class InstanceTypeDef(TypedDict):
    Id: NotRequired[str],

LaunchConfigurationTypeDef#

# LaunchConfigurationTypeDef definition

class LaunchConfigurationTypeDef(TypedDict):
    Name: NotRequired[str],

LaunchTemplateTypeDef#

# LaunchTemplateTypeDef definition

class LaunchTemplateTypeDef(TypedDict):
    Id: NotRequired[str],

LoadBalancerTypeDef#

# LoadBalancerTypeDef definition

class LoadBalancerTypeDef(TypedDict):
    Name: NotRequired[str],

QueueTypeDef#

# QueueTypeDef definition

class QueueTypeDef(TypedDict):
    Name: NotRequired[str],
    URL: NotRequired[str],

TriggerTypeDef#

# TriggerTypeDef definition

class TriggerTypeDef(TypedDict):
    Name: NotRequired[str],

EventDescriptionTypeDef#

# EventDescriptionTypeDef definition

class EventDescriptionTypeDef(TypedDict):
    EventDate: NotRequired[datetime],
    Message: NotRequired[str],
    ApplicationName: NotRequired[str],
    VersionLabel: NotRequired[str],
    TemplateName: NotRequired[str],
    EnvironmentName: NotRequired[str],
    PlatformArn: NotRequired[str],
    RequestId: NotRequired[str],
    Severity: NotRequired[EventSeverityType],  # (1)
  1. See EventSeverityType

SolutionStackDescriptionTypeDef#

# SolutionStackDescriptionTypeDef definition

class SolutionStackDescriptionTypeDef(TypedDict):
    SolutionStackName: NotRequired[str],
    PermittedFileTypes: NotRequired[List[str]],

SearchFilterTypeDef#

# SearchFilterTypeDef definition

class SearchFilterTypeDef(TypedDict):
    Attribute: NotRequired[str],
    Operator: NotRequired[str],
    Values: NotRequired[Sequence[str]],

PlatformBranchSummaryTypeDef#

# PlatformBranchSummaryTypeDef definition

class PlatformBranchSummaryTypeDef(TypedDict):
    PlatformName: NotRequired[str],
    BranchName: NotRequired[str],
    LifecycleState: NotRequired[str],
    BranchOrder: NotRequired[int],
    SupportedTierList: NotRequired[List[str]],

PlatformFilterTypeDef#

# PlatformFilterTypeDef definition

class PlatformFilterTypeDef(TypedDict):
    Type: NotRequired[str],
    Operator: NotRequired[str],
    Values: NotRequired[Sequence[str]],

ListTagsForResourceMessageRequestTypeDef#

# ListTagsForResourceMessageRequestTypeDef definition

class ListTagsForResourceMessageRequestTypeDef(TypedDict):
    ResourceArn: str,

ListenerTypeDef#

# ListenerTypeDef definition

class ListenerTypeDef(TypedDict):
    Protocol: NotRequired[str],
    Port: NotRequired[int],

PlatformFrameworkTypeDef#

# PlatformFrameworkTypeDef definition

class PlatformFrameworkTypeDef(TypedDict):
    Name: NotRequired[str],
    Version: NotRequired[str],

PlatformProgrammingLanguageTypeDef#

# PlatformProgrammingLanguageTypeDef definition

class PlatformProgrammingLanguageTypeDef(TypedDict):
    Name: NotRequired[str],
    Version: NotRequired[str],

RebuildEnvironmentMessageRequestTypeDef#

# RebuildEnvironmentMessageRequestTypeDef definition

class RebuildEnvironmentMessageRequestTypeDef(TypedDict):
    EnvironmentId: NotRequired[str],
    EnvironmentName: NotRequired[str],