Skip to content

Typed dictionaries

Index > ECS > Typed dictionaries

Auto-generated documentation for ECS type annotations stubs module mypy-boto3-ecs.

AttachmentStateChangeTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import AttachmentStateChangeTypeDef

def get_value() -> AttachmentStateChangeTypeDef:
    return {
        "attachmentArn": ...,
        "status": ...,
    }
Definition
class AttachmentStateChangeTypeDef(TypedDict):
    attachmentArn: str,
    status: str,

KeyValuePairTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import KeyValuePairTypeDef

def get_value() -> KeyValuePairTypeDef:
    return {
        "name": ...,
    }
Definition
class KeyValuePairTypeDef(TypedDict):
    name: NotRequired[str],
    value: NotRequired[str],

AttributeTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import AttributeTypeDef

def get_value() -> AttributeTypeDef:
    return {
        "name": ...,
    }
Definition
class AttributeTypeDef(TypedDict):
    name: str,
    value: NotRequired[str],
    targetType: NotRequired[TargetTypeType],  # (1)
    targetId: NotRequired[str],
  1. See TargetTypeType

ManagedScalingTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import ManagedScalingTypeDef

def get_value() -> ManagedScalingTypeDef:
    return {
        "status": ...,
    }
Definition
class ManagedScalingTypeDef(TypedDict):
    status: NotRequired[ManagedScalingStatusType],  # (1)
    targetCapacity: NotRequired[int],
    minimumScalingStepSize: NotRequired[int],
    maximumScalingStepSize: NotRequired[int],
    instanceWarmupPeriod: NotRequired[int],
  1. See ManagedScalingStatusType

AwsVpcConfigurationTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import AwsVpcConfigurationTypeDef

def get_value() -> AwsVpcConfigurationTypeDef:
    return {
        "subnets": ...,
    }
Definition
class AwsVpcConfigurationTypeDef(TypedDict):
    subnets: Sequence[str],
    securityGroups: NotRequired[Sequence[str]],
    assignPublicIp: NotRequired[AssignPublicIpType],  # (1)
  1. See AssignPublicIpType

CapacityProviderStrategyItemTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import CapacityProviderStrategyItemTypeDef

def get_value() -> CapacityProviderStrategyItemTypeDef:
    return {
        "capacityProvider": ...,
    }
Definition
class CapacityProviderStrategyItemTypeDef(TypedDict):
    capacityProvider: str,
    weight: NotRequired[int],
    base: NotRequired[int],

TagTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import TagTypeDef

def get_value() -> TagTypeDef:
    return {
        "key": ...,
    }
Definition
class TagTypeDef(TypedDict):
    key: NotRequired[str],
    value: NotRequired[str],

ClusterServiceConnectDefaultsRequestTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import ClusterServiceConnectDefaultsRequestTypeDef

def get_value() -> ClusterServiceConnectDefaultsRequestTypeDef:
    return {
        "namespace": ...,
    }
Definition
class ClusterServiceConnectDefaultsRequestTypeDef(TypedDict):
    namespace: str,

ClusterServiceConnectDefaultsTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import ClusterServiceConnectDefaultsTypeDef

def get_value() -> ClusterServiceConnectDefaultsTypeDef:
    return {
        "namespace": ...,
    }
Definition
class ClusterServiceConnectDefaultsTypeDef(TypedDict):
    namespace: NotRequired[str],

ClusterSettingTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import ClusterSettingTypeDef

def get_value() -> ClusterSettingTypeDef:
    return {
        "name": ...,
    }
Definition
class ClusterSettingTypeDef(TypedDict):
    name: NotRequired[ClusterSettingNameType],  # (1)
    value: NotRequired[str],
  1. See ClusterSettingNameType

ContainerDependencyTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import ContainerDependencyTypeDef

def get_value() -> ContainerDependencyTypeDef:
    return {
        "containerName": ...,
        "condition": ...,
    }
Definition
class ContainerDependencyTypeDef(TypedDict):
    containerName: str,
    condition: ContainerConditionType,  # (1)
  1. See ContainerConditionType

EnvironmentFileTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import EnvironmentFileTypeDef

def get_value() -> EnvironmentFileTypeDef:
    return {
        "value": ...,
        "type": ...,
    }
Definition
class EnvironmentFileTypeDef(TypedDict):
    value: str,
    type: EnvironmentFileTypeType,  # (1)
  1. See EnvironmentFileTypeType

FirelensConfigurationTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import FirelensConfigurationTypeDef

def get_value() -> FirelensConfigurationTypeDef:
    return {
        "type": ...,
    }
Definition
class FirelensConfigurationTypeDef(TypedDict):
    type: FirelensConfigurationTypeType,  # (1)
    options: NotRequired[Dict[str, str]],
  1. See FirelensConfigurationTypeType

HealthCheckTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import HealthCheckTypeDef

def get_value() -> HealthCheckTypeDef:
    return {
        "command": ...,
    }
Definition
class HealthCheckTypeDef(TypedDict):
    command: List[str],
    interval: NotRequired[int],
    timeout: NotRequired[int],
    retries: NotRequired[int],
    startPeriod: NotRequired[int],

HostEntryTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import HostEntryTypeDef

def get_value() -> HostEntryTypeDef:
    return {
        "hostname": ...,
        "ipAddress": ...,
    }
Definition
class HostEntryTypeDef(TypedDict):
    hostname: str,
    ipAddress: str,

MountPointTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import MountPointTypeDef

def get_value() -> MountPointTypeDef:
    return {
        "sourceVolume": ...,
    }
Definition
class MountPointTypeDef(TypedDict):
    sourceVolume: NotRequired[str],
    containerPath: NotRequired[str],
    readOnly: NotRequired[bool],

PortMappingTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import PortMappingTypeDef

def get_value() -> PortMappingTypeDef:
    return {
        "containerPort": ...,
    }
Definition
class PortMappingTypeDef(TypedDict):
    containerPort: NotRequired[int],
    hostPort: NotRequired[int],
    protocol: NotRequired[TransportProtocolType],  # (1)
    name: NotRequired[str],
    appProtocol: NotRequired[ApplicationProtocolType],  # (2)
    containerPortRange: NotRequired[str],
  1. See TransportProtocolType
  2. See ApplicationProtocolType

RepositoryCredentialsTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import RepositoryCredentialsTypeDef

def get_value() -> RepositoryCredentialsTypeDef:
    return {
        "credentialsParameter": ...,
    }
Definition
class RepositoryCredentialsTypeDef(TypedDict):
    credentialsParameter: str,

ResourceRequirementTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import ResourceRequirementTypeDef

def get_value() -> ResourceRequirementTypeDef:
    return {
        "value": ...,
        "type": ...,
    }
Definition
class ResourceRequirementTypeDef(TypedDict):
    value: str,
    type: ResourceTypeType,  # (1)
  1. See ResourceTypeType

SecretTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import SecretTypeDef

def get_value() -> SecretTypeDef:
    return {
        "name": ...,
        "valueFrom": ...,
    }
Definition
class SecretTypeDef(TypedDict):
    name: str,
    valueFrom: str,

SystemControlTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import SystemControlTypeDef

def get_value() -> SystemControlTypeDef:
    return {
        "namespace": ...,
    }
Definition
class SystemControlTypeDef(TypedDict):
    namespace: NotRequired[str],
    value: NotRequired[str],

UlimitTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import UlimitTypeDef

def get_value() -> UlimitTypeDef:
    return {
        "name": ...,
        "softLimit": ...,
        "hardLimit": ...,
    }
Definition
class UlimitTypeDef(TypedDict):
    name: UlimitNameType,  # (1)
    softLimit: int,
    hardLimit: int,
  1. See UlimitNameType

VolumeFromTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import VolumeFromTypeDef

def get_value() -> VolumeFromTypeDef:
    return {
        "sourceContainer": ...,
    }
Definition
class VolumeFromTypeDef(TypedDict):
    sourceContainer: NotRequired[str],
    readOnly: NotRequired[bool],

InstanceHealthCheckResultTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import InstanceHealthCheckResultTypeDef

def get_value() -> InstanceHealthCheckResultTypeDef:
    return {
        "type": ...,
    }
Definition
class InstanceHealthCheckResultTypeDef(TypedDict):
    type: NotRequired[InstanceHealthCheckTypeType],  # (1)
    status: NotRequired[InstanceHealthCheckStateType],  # (2)
    lastUpdated: NotRequired[datetime],
    lastStatusChange: NotRequired[datetime],
  1. See InstanceHealthCheckTypeType
  2. See InstanceHealthCheckStateType

ResourceTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import ResourceTypeDef

def get_value() -> ResourceTypeDef:
    return {
        "name": ...,
    }
Definition
class ResourceTypeDef(TypedDict):
    name: NotRequired[str],
    type: NotRequired[str],
    doubleValue: NotRequired[float],
    longValue: NotRequired[int],
    integerValue: NotRequired[int],
    stringSetValue: NotRequired[List[str]],

VersionInfoTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import VersionInfoTypeDef

def get_value() -> VersionInfoTypeDef:
    return {
        "agentVersion": ...,
    }
Definition
class VersionInfoTypeDef(TypedDict):
    agentVersion: NotRequired[str],
    agentHash: NotRequired[str],
    dockerVersion: NotRequired[str],

NetworkBindingTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import NetworkBindingTypeDef

def get_value() -> NetworkBindingTypeDef:
    return {
        "bindIP": ...,
    }
Definition
class NetworkBindingTypeDef(TypedDict):
    bindIP: NotRequired[str],
    containerPort: NotRequired[int],
    hostPort: NotRequired[int],
    protocol: NotRequired[TransportProtocolType],  # (1)
    containerPortRange: NotRequired[str],
    hostPortRange: NotRequired[str],
  1. See TransportProtocolType

ManagedAgentTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import ManagedAgentTypeDef

def get_value() -> ManagedAgentTypeDef:
    return {
        "lastStartedAt": ...,
    }
Definition
class ManagedAgentTypeDef(TypedDict):
    lastStartedAt: NotRequired[datetime],
    name: NotRequired[ManagedAgentNameType],  # (1)
    reason: NotRequired[str],
    lastStatus: NotRequired[str],
  1. See ManagedAgentNameType

NetworkInterfaceTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import NetworkInterfaceTypeDef

def get_value() -> NetworkInterfaceTypeDef:
    return {
        "attachmentId": ...,
    }
Definition
class NetworkInterfaceTypeDef(TypedDict):
    attachmentId: NotRequired[str],
    privateIpv4Address: NotRequired[str],
    ipv6Address: NotRequired[str],

ResponseMetadataTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
Definition
class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

DeploymentControllerTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import DeploymentControllerTypeDef

def get_value() -> DeploymentControllerTypeDef:
    return {
        "type": ...,
    }
Definition
class DeploymentControllerTypeDef(TypedDict):
    type: DeploymentControllerTypeType,  # (1)
  1. See DeploymentControllerTypeType

LoadBalancerTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import LoadBalancerTypeDef

def get_value() -> LoadBalancerTypeDef:
    return {
        "targetGroupArn": ...,
    }
Definition
class LoadBalancerTypeDef(TypedDict):
    targetGroupArn: NotRequired[str],
    loadBalancerName: NotRequired[str],
    containerName: NotRequired[str],
    containerPort: NotRequired[int],

PlacementConstraintTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import PlacementConstraintTypeDef

def get_value() -> PlacementConstraintTypeDef:
    return {
        "type": ...,
    }
Definition
class PlacementConstraintTypeDef(TypedDict):
    type: NotRequired[PlacementConstraintTypeType],  # (1)
    expression: NotRequired[str],
  1. See PlacementConstraintTypeType

PlacementStrategyTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import PlacementStrategyTypeDef

def get_value() -> PlacementStrategyTypeDef:
    return {
        "type": ...,
    }
Definition
class PlacementStrategyTypeDef(TypedDict):
    type: NotRequired[PlacementStrategyTypeType],  # (1)
    field: NotRequired[str],
  1. See PlacementStrategyTypeType

ServiceRegistryTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import ServiceRegistryTypeDef

def get_value() -> ServiceRegistryTypeDef:
    return {
        "registryArn": ...,
    }
Definition
class ServiceRegistryTypeDef(TypedDict):
    registryArn: NotRequired[str],
    port: NotRequired[int],
    containerName: NotRequired[str],
    containerPort: NotRequired[int],

ScaleTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import ScaleTypeDef

def get_value() -> ScaleTypeDef:
    return {
        "value": ...,
    }
Definition
class ScaleTypeDef(TypedDict):
    value: NotRequired[float],
    unit: NotRequired[ScaleUnitType],  # (1)
  1. See ScaleUnitType

DeleteAccountSettingRequestRequestTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import DeleteAccountSettingRequestRequestTypeDef

def get_value() -> DeleteAccountSettingRequestRequestTypeDef:
    return {
        "name": ...,
    }
Definition
class DeleteAccountSettingRequestRequestTypeDef(TypedDict):
    name: SettingNameType,  # (1)
    principalArn: NotRequired[str],
  1. See SettingNameType

SettingTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import SettingTypeDef

def get_value() -> SettingTypeDef:
    return {
        "name": ...,
    }
Definition
class SettingTypeDef(TypedDict):
    name: NotRequired[SettingNameType],  # (1)
    value: NotRequired[str],
    principalArn: NotRequired[str],
  1. See SettingNameType

DeleteCapacityProviderRequestRequestTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import DeleteCapacityProviderRequestRequestTypeDef

def get_value() -> DeleteCapacityProviderRequestRequestTypeDef:
    return {
        "capacityProvider": ...,
    }
Definition
class DeleteCapacityProviderRequestRequestTypeDef(TypedDict):
    capacityProvider: str,

DeleteClusterRequestRequestTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import DeleteClusterRequestRequestTypeDef

def get_value() -> DeleteClusterRequestRequestTypeDef:
    return {
        "cluster": ...,
    }
Definition
class DeleteClusterRequestRequestTypeDef(TypedDict):
    cluster: str,

DeleteServiceRequestRequestTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import DeleteServiceRequestRequestTypeDef

def get_value() -> DeleteServiceRequestRequestTypeDef:
    return {
        "service": ...,
    }
Definition
class DeleteServiceRequestRequestTypeDef(TypedDict):
    service: str,
    cluster: NotRequired[str],
    force: NotRequired[bool],

DeleteTaskSetRequestRequestTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import DeleteTaskSetRequestRequestTypeDef

def get_value() -> DeleteTaskSetRequestRequestTypeDef:
    return {
        "cluster": ...,
        "service": ...,
        "taskSet": ...,
    }
Definition
class DeleteTaskSetRequestRequestTypeDef(TypedDict):
    cluster: str,
    service: str,
    taskSet: str,
    force: NotRequired[bool],

DeploymentAlarmsTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import DeploymentAlarmsTypeDef

def get_value() -> DeploymentAlarmsTypeDef:
    return {
        "alarmNames": ...,
        "enable": ...,
        "rollback": ...,
    }
Definition
class DeploymentAlarmsTypeDef(TypedDict):
    alarmNames: Sequence[str],
    enable: bool,
    rollback: bool,

DeploymentCircuitBreakerTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import DeploymentCircuitBreakerTypeDef

def get_value() -> DeploymentCircuitBreakerTypeDef:
    return {
        "enable": ...,
        "rollback": ...,
    }
Definition
class DeploymentCircuitBreakerTypeDef(TypedDict):
    enable: bool,
    rollback: bool,

ServiceConnectServiceResourceTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import ServiceConnectServiceResourceTypeDef

def get_value() -> ServiceConnectServiceResourceTypeDef:
    return {
        "discoveryName": ...,
    }
Definition
class ServiceConnectServiceResourceTypeDef(TypedDict):
    discoveryName: NotRequired[str],
    discoveryArn: NotRequired[str],

DeregisterContainerInstanceRequestRequestTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import DeregisterContainerInstanceRequestRequestTypeDef

def get_value() -> DeregisterContainerInstanceRequestRequestTypeDef:
    return {
        "containerInstance": ...,
    }
Definition
class DeregisterContainerInstanceRequestRequestTypeDef(TypedDict):
    containerInstance: str,
    cluster: NotRequired[str],
    force: NotRequired[bool],

DeregisterTaskDefinitionRequestRequestTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import DeregisterTaskDefinitionRequestRequestTypeDef

def get_value() -> DeregisterTaskDefinitionRequestRequestTypeDef:
    return {
        "taskDefinition": ...,
    }
Definition
class DeregisterTaskDefinitionRequestRequestTypeDef(TypedDict):
    taskDefinition: str,

DescribeCapacityProvidersRequestRequestTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import DescribeCapacityProvidersRequestRequestTypeDef

def get_value() -> DescribeCapacityProvidersRequestRequestTypeDef:
    return {
        "capacityProviders": ...,
    }
Definition
class DescribeCapacityProvidersRequestRequestTypeDef(TypedDict):
    capacityProviders: NotRequired[Sequence[str]],
    include: NotRequired[Sequence[CapacityProviderFieldType]],  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
  1. See CapacityProviderFieldType

FailureTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import FailureTypeDef

def get_value() -> FailureTypeDef:
    return {
        "arn": ...,
    }
Definition
class FailureTypeDef(TypedDict):
    arn: NotRequired[str],
    reason: NotRequired[str],
    detail: NotRequired[str],

DescribeClustersRequestRequestTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import DescribeClustersRequestRequestTypeDef

def get_value() -> DescribeClustersRequestRequestTypeDef:
    return {
        "clusters": ...,
    }
Definition
class DescribeClustersRequestRequestTypeDef(TypedDict):
    clusters: NotRequired[Sequence[str]],
    include: NotRequired[Sequence[ClusterFieldType]],  # (1)
  1. See ClusterFieldType

DescribeContainerInstancesRequestRequestTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import DescribeContainerInstancesRequestRequestTypeDef

def get_value() -> DescribeContainerInstancesRequestRequestTypeDef:
    return {
        "containerInstances": ...,
    }
Definition
class DescribeContainerInstancesRequestRequestTypeDef(TypedDict):
    containerInstances: Sequence[str],
    cluster: NotRequired[str],
    include: NotRequired[Sequence[ContainerInstanceFieldType]],  # (1)
  1. See ContainerInstanceFieldType

DescribeServicesRequestRequestTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import DescribeServicesRequestRequestTypeDef

def get_value() -> DescribeServicesRequestRequestTypeDef:
    return {
        "services": ...,
    }
Definition
class DescribeServicesRequestRequestTypeDef(TypedDict):
    services: Sequence[str],
    cluster: NotRequired[str],
    include: NotRequired[Sequence[ServiceFieldType]],  # (1)
  1. See ServiceFieldType

WaiterConfigTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import WaiterConfigTypeDef

def get_value() -> WaiterConfigTypeDef:
    return {
        "Delay": ...,
    }
Definition
class WaiterConfigTypeDef(TypedDict):
    Delay: NotRequired[int],
    MaxAttempts: NotRequired[int],

DescribeTaskDefinitionRequestRequestTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import DescribeTaskDefinitionRequestRequestTypeDef

def get_value() -> DescribeTaskDefinitionRequestRequestTypeDef:
    return {
        "taskDefinition": ...,
    }
Definition
class DescribeTaskDefinitionRequestRequestTypeDef(TypedDict):
    taskDefinition: str,
    include: NotRequired[Sequence[TaskDefinitionFieldType]],  # (1)
  1. See TaskDefinitionFieldType

DescribeTaskSetsRequestRequestTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import DescribeTaskSetsRequestRequestTypeDef

def get_value() -> DescribeTaskSetsRequestRequestTypeDef:
    return {
        "cluster": ...,
        "service": ...,
    }
Definition
class DescribeTaskSetsRequestRequestTypeDef(TypedDict):
    cluster: str,
    service: str,
    taskSets: NotRequired[Sequence[str]],
    include: NotRequired[Sequence[TaskSetFieldType]],  # (1)
  1. See TaskSetFieldType

DescribeTasksRequestRequestTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import DescribeTasksRequestRequestTypeDef

def get_value() -> DescribeTasksRequestRequestTypeDef:
    return {
        "tasks": ...,
    }
Definition
class DescribeTasksRequestRequestTypeDef(TypedDict):
    tasks: Sequence[str],
    cluster: NotRequired[str],
    include: NotRequired[Sequence[TaskFieldType]],  # (1)
  1. See TaskFieldType

DeviceTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import DeviceTypeDef

def get_value() -> DeviceTypeDef:
    return {
        "hostPath": ...,
    }
Definition
class DeviceTypeDef(TypedDict):
    hostPath: str,
    containerPath: NotRequired[str],
    permissions: NotRequired[List[DeviceCgroupPermissionType]],  # (1)
  1. See DeviceCgroupPermissionType

DiscoverPollEndpointRequestRequestTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import DiscoverPollEndpointRequestRequestTypeDef

def get_value() -> DiscoverPollEndpointRequestRequestTypeDef:
    return {
        "containerInstance": ...,
    }
Definition
class DiscoverPollEndpointRequestRequestTypeDef(TypedDict):
    containerInstance: NotRequired[str],
    cluster: NotRequired[str],

DockerVolumeConfigurationTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import DockerVolumeConfigurationTypeDef

def get_value() -> DockerVolumeConfigurationTypeDef:
    return {
        "scope": ...,
    }
Definition
class DockerVolumeConfigurationTypeDef(TypedDict):
    scope: NotRequired[ScopeType],  # (1)
    autoprovision: NotRequired[bool],
    driver: NotRequired[str],
    driverOpts: NotRequired[Dict[str, str]],
    labels: NotRequired[Dict[str, str]],
  1. See ScopeType

EFSAuthorizationConfigTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import EFSAuthorizationConfigTypeDef

def get_value() -> EFSAuthorizationConfigTypeDef:
    return {
        "accessPointId": ...,
    }
Definition
class EFSAuthorizationConfigTypeDef(TypedDict):
    accessPointId: NotRequired[str],
    iam: NotRequired[EFSAuthorizationConfigIAMType],  # (1)
  1. See EFSAuthorizationConfigIAMType

EphemeralStorageTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import EphemeralStorageTypeDef

def get_value() -> EphemeralStorageTypeDef:
    return {
        "sizeInGiB": ...,
    }
Definition
class EphemeralStorageTypeDef(TypedDict):
    sizeInGiB: int,

ExecuteCommandLogConfigurationTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import ExecuteCommandLogConfigurationTypeDef

def get_value() -> ExecuteCommandLogConfigurationTypeDef:
    return {
        "cloudWatchLogGroupName": ...,
    }
Definition
class ExecuteCommandLogConfigurationTypeDef(TypedDict):
    cloudWatchLogGroupName: NotRequired[str],
    cloudWatchEncryptionEnabled: NotRequired[bool],
    s3BucketName: NotRequired[str],
    s3EncryptionEnabled: NotRequired[bool],
    s3KeyPrefix: NotRequired[str],

ExecuteCommandRequestRequestTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import ExecuteCommandRequestRequestTypeDef

def get_value() -> ExecuteCommandRequestRequestTypeDef:
    return {
        "command": ...,
        "interactive": ...,
        "task": ...,
    }
Definition
class ExecuteCommandRequestRequestTypeDef(TypedDict):
    command: str,
    interactive: bool,
    task: str,
    cluster: NotRequired[str],
    container: NotRequired[str],

SessionTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import SessionTypeDef

def get_value() -> SessionTypeDef:
    return {
        "sessionId": ...,
    }
Definition
class SessionTypeDef(TypedDict):
    sessionId: NotRequired[str],
    streamUrl: NotRequired[str],
    tokenValue: NotRequired[str],

FSxWindowsFileServerAuthorizationConfigTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import FSxWindowsFileServerAuthorizationConfigTypeDef

def get_value() -> FSxWindowsFileServerAuthorizationConfigTypeDef:
    return {
        "credentialsParameter": ...,
        "domain": ...,
    }
Definition
class FSxWindowsFileServerAuthorizationConfigTypeDef(TypedDict):
    credentialsParameter: str,
    domain: str,

GetTaskProtectionRequestRequestTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import GetTaskProtectionRequestRequestTypeDef

def get_value() -> GetTaskProtectionRequestRequestTypeDef:
    return {
        "cluster": ...,
    }
Definition
class GetTaskProtectionRequestRequestTypeDef(TypedDict):
    cluster: str,
    tasks: NotRequired[Sequence[str]],

ProtectedTaskTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import ProtectedTaskTypeDef

def get_value() -> ProtectedTaskTypeDef:
    return {
        "taskArn": ...,
    }
Definition
class ProtectedTaskTypeDef(TypedDict):
    taskArn: NotRequired[str],
    protectionEnabled: NotRequired[bool],
    expirationDate: NotRequired[datetime],

HostVolumePropertiesTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import HostVolumePropertiesTypeDef

def get_value() -> HostVolumePropertiesTypeDef:
    return {
        "sourcePath": ...,
    }
Definition
class HostVolumePropertiesTypeDef(TypedDict):
    sourcePath: NotRequired[str],

InferenceAcceleratorOverrideTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import InferenceAcceleratorOverrideTypeDef

def get_value() -> InferenceAcceleratorOverrideTypeDef:
    return {
        "deviceName": ...,
    }
Definition
class InferenceAcceleratorOverrideTypeDef(TypedDict):
    deviceName: NotRequired[str],
    deviceType: NotRequired[str],

InferenceAcceleratorTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import InferenceAcceleratorTypeDef

def get_value() -> InferenceAcceleratorTypeDef:
    return {
        "deviceName": ...,
        "deviceType": ...,
    }
Definition
class InferenceAcceleratorTypeDef(TypedDict):
    deviceName: str,
    deviceType: str,

KernelCapabilitiesTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import KernelCapabilitiesTypeDef

def get_value() -> KernelCapabilitiesTypeDef:
    return {
        "add": ...,
    }
Definition
class KernelCapabilitiesTypeDef(TypedDict):
    add: NotRequired[List[str]],
    drop: NotRequired[List[str]],

TmpfsTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import TmpfsTypeDef

def get_value() -> TmpfsTypeDef:
    return {
        "containerPath": ...,
        "size": ...,
    }
Definition
class TmpfsTypeDef(TypedDict):
    containerPath: str,
    size: int,
    mountOptions: NotRequired[List[str]],

PaginatorConfigTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }
Definition
class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListAccountSettingsRequestRequestTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import ListAccountSettingsRequestRequestTypeDef

def get_value() -> ListAccountSettingsRequestRequestTypeDef:
    return {
        "name": ...,
    }
Definition
class ListAccountSettingsRequestRequestTypeDef(TypedDict):
    name: NotRequired[SettingNameType],  # (1)
    value: NotRequired[str],
    principalArn: NotRequired[str],
    effectiveSettings: NotRequired[bool],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See SettingNameType

ListAttributesRequestRequestTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import ListAttributesRequestRequestTypeDef

def get_value() -> ListAttributesRequestRequestTypeDef:
    return {
        "targetType": ...,
    }
Definition
class ListAttributesRequestRequestTypeDef(TypedDict):
    targetType: TargetTypeType,  # (1)
    cluster: NotRequired[str],
    attributeName: NotRequired[str],
    attributeValue: NotRequired[str],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See TargetTypeType

ListClustersRequestRequestTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import ListClustersRequestRequestTypeDef

def get_value() -> ListClustersRequestRequestTypeDef:
    return {
        "nextToken": ...,
    }
Definition
class ListClustersRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListContainerInstancesRequestRequestTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import ListContainerInstancesRequestRequestTypeDef

def get_value() -> ListContainerInstancesRequestRequestTypeDef:
    return {
        "cluster": ...,
    }
Definition
class ListContainerInstancesRequestRequestTypeDef(TypedDict):
    cluster: NotRequired[str],
    filter: NotRequired[str],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    status: NotRequired[ContainerInstanceStatusType],  # (1)
  1. See ContainerInstanceStatusType

ListServicesByNamespaceRequestRequestTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import ListServicesByNamespaceRequestRequestTypeDef

def get_value() -> ListServicesByNamespaceRequestRequestTypeDef:
    return {
        "namespace": ...,
    }
Definition
class ListServicesByNamespaceRequestRequestTypeDef(TypedDict):
    namespace: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListServicesRequestRequestTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import ListServicesRequestRequestTypeDef

def get_value() -> ListServicesRequestRequestTypeDef:
    return {
        "cluster": ...,
    }
Definition
class ListServicesRequestRequestTypeDef(TypedDict):
    cluster: NotRequired[str],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    launchType: NotRequired[LaunchTypeType],  # (1)
    schedulingStrategy: NotRequired[SchedulingStrategyType],  # (2)
  1. See LaunchTypeType
  2. See SchedulingStrategyType

ListTagsForResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import ListTagsForResourceRequestRequestTypeDef

def get_value() -> ListTagsForResourceRequestRequestTypeDef:
    return {
        "resourceArn": ...,
    }
Definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

ListTaskDefinitionFamiliesRequestRequestTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import ListTaskDefinitionFamiliesRequestRequestTypeDef

def get_value() -> ListTaskDefinitionFamiliesRequestRequestTypeDef:
    return {
        "familyPrefix": ...,
    }
Definition
class ListTaskDefinitionFamiliesRequestRequestTypeDef(TypedDict):
    familyPrefix: NotRequired[str],
    status: NotRequired[TaskDefinitionFamilyStatusType],  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See TaskDefinitionFamilyStatusType

ListTaskDefinitionsRequestRequestTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import ListTaskDefinitionsRequestRequestTypeDef

def get_value() -> ListTaskDefinitionsRequestRequestTypeDef:
    return {
        "familyPrefix": ...,
    }
Definition
class ListTaskDefinitionsRequestRequestTypeDef(TypedDict):
    familyPrefix: NotRequired[str],
    status: NotRequired[TaskDefinitionStatusType],  # (1)
    sort: NotRequired[SortOrderType],  # (2)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See TaskDefinitionStatusType
  2. See SortOrderType

ListTasksRequestRequestTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import ListTasksRequestRequestTypeDef

def get_value() -> ListTasksRequestRequestTypeDef:
    return {
        "cluster": ...,
    }
Definition
class ListTasksRequestRequestTypeDef(TypedDict):
    cluster: NotRequired[str],
    containerInstance: NotRequired[str],
    family: NotRequired[str],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    startedBy: NotRequired[str],
    serviceName: NotRequired[str],
    desiredStatus: NotRequired[DesiredStatusType],  # (1)
    launchType: NotRequired[LaunchTypeType],  # (2)
  1. See DesiredStatusType
  2. See LaunchTypeType

ManagedAgentStateChangeTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import ManagedAgentStateChangeTypeDef

def get_value() -> ManagedAgentStateChangeTypeDef:
    return {
        "containerName": ...,
        "managedAgentName": ...,
        "status": ...,
    }
Definition
class ManagedAgentStateChangeTypeDef(TypedDict):
    containerName: str,
    managedAgentName: ManagedAgentNameType,  # (1)
    status: str,
    reason: NotRequired[str],
  1. See ManagedAgentNameType

PlatformDeviceTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import PlatformDeviceTypeDef

def get_value() -> PlatformDeviceTypeDef:
    return {
        "id": ...,
        "type": ...,
    }
Definition
class PlatformDeviceTypeDef(TypedDict):
    id: str,
    type: PlatformDeviceTypeType,  # (1)
  1. See PlatformDeviceTypeType

PutAccountSettingDefaultRequestRequestTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import PutAccountSettingDefaultRequestRequestTypeDef

def get_value() -> PutAccountSettingDefaultRequestRequestTypeDef:
    return {
        "name": ...,
        "value": ...,
    }
Definition
class PutAccountSettingDefaultRequestRequestTypeDef(TypedDict):
    name: SettingNameType,  # (1)
    value: str,
  1. See SettingNameType

PutAccountSettingRequestRequestTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import PutAccountSettingRequestRequestTypeDef

def get_value() -> PutAccountSettingRequestRequestTypeDef:
    return {
        "name": ...,
        "value": ...,
    }
Definition
class PutAccountSettingRequestRequestTypeDef(TypedDict):
    name: SettingNameType,  # (1)
    value: str,
    principalArn: NotRequired[str],
  1. See SettingNameType

RuntimePlatformTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import RuntimePlatformTypeDef

def get_value() -> RuntimePlatformTypeDef:
    return {
        "cpuArchitecture": ...,
    }
Definition
class RuntimePlatformTypeDef(TypedDict):
    cpuArchitecture: NotRequired[CPUArchitectureType],  # (1)
    operatingSystemFamily: NotRequired[OSFamilyType],  # (2)
  1. See CPUArchitectureType
  2. See OSFamilyType

TaskDefinitionPlacementConstraintTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import TaskDefinitionPlacementConstraintTypeDef

def get_value() -> TaskDefinitionPlacementConstraintTypeDef:
    return {
        "type": ...,
    }
Definition
class TaskDefinitionPlacementConstraintTypeDef(TypedDict):
    type: NotRequired[TaskDefinitionPlacementConstraintTypeType],  # (1)
    expression: NotRequired[str],
  1. See TaskDefinitionPlacementConstraintTypeType

ServiceConnectClientAliasTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import ServiceConnectClientAliasTypeDef

def get_value() -> ServiceConnectClientAliasTypeDef:
    return {
        "port": ...,
    }
Definition
class ServiceConnectClientAliasTypeDef(TypedDict):
    port: int,
    dnsName: NotRequired[str],

ServiceEventTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import ServiceEventTypeDef

def get_value() -> ServiceEventTypeDef:
    return {
        "id": ...,
    }
Definition
class ServiceEventTypeDef(TypedDict):
    id: NotRequired[str],
    createdAt: NotRequired[datetime],
    message: NotRequired[str],

StopTaskRequestRequestTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import StopTaskRequestRequestTypeDef

def get_value() -> StopTaskRequestRequestTypeDef:
    return {
        "task": ...,
    }
Definition
class StopTaskRequestRequestTypeDef(TypedDict):
    task: str,
    cluster: NotRequired[str],
    reason: NotRequired[str],

UntagResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import UntagResourceRequestRequestTypeDef

def get_value() -> UntagResourceRequestRequestTypeDef:
    return {
        "resourceArn": ...,
        "tagKeys": ...,
    }
Definition
class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

UpdateContainerAgentRequestRequestTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import UpdateContainerAgentRequestRequestTypeDef

def get_value() -> UpdateContainerAgentRequestRequestTypeDef:
    return {
        "containerInstance": ...,
    }
Definition
class UpdateContainerAgentRequestRequestTypeDef(TypedDict):
    containerInstance: str,
    cluster: NotRequired[str],

UpdateContainerInstancesStateRequestRequestTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import UpdateContainerInstancesStateRequestRequestTypeDef

def get_value() -> UpdateContainerInstancesStateRequestRequestTypeDef:
    return {
        "containerInstances": ...,
        "status": ...,
    }
Definition
class UpdateContainerInstancesStateRequestRequestTypeDef(TypedDict):
    containerInstances: Sequence[str],
    status: ContainerInstanceStatusType,  # (1)
    cluster: NotRequired[str],
  1. See ContainerInstanceStatusType

UpdateServicePrimaryTaskSetRequestRequestTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import UpdateServicePrimaryTaskSetRequestRequestTypeDef

def get_value() -> UpdateServicePrimaryTaskSetRequestRequestTypeDef:
    return {
        "cluster": ...,
        "service": ...,
        "primaryTaskSet": ...,
    }
Definition
class UpdateServicePrimaryTaskSetRequestRequestTypeDef(TypedDict):
    cluster: str,
    service: str,
    primaryTaskSet: str,

UpdateTaskProtectionRequestRequestTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import UpdateTaskProtectionRequestRequestTypeDef

def get_value() -> UpdateTaskProtectionRequestRequestTypeDef:
    return {
        "cluster": ...,
        "tasks": ...,
        "protectionEnabled": ...,
    }
Definition
class UpdateTaskProtectionRequestRequestTypeDef(TypedDict):
    cluster: str,
    tasks: Sequence[str],
    protectionEnabled: bool,
    expiresInMinutes: NotRequired[int],

SubmitAttachmentStateChangesRequestRequestTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import SubmitAttachmentStateChangesRequestRequestTypeDef

def get_value() -> SubmitAttachmentStateChangesRequestRequestTypeDef:
    return {
        "attachments": ...,
    }
Definition
class SubmitAttachmentStateChangesRequestRequestTypeDef(TypedDict):
    attachments: Sequence[AttachmentStateChangeTypeDef],  # (1)
    cluster: NotRequired[str],
  1. See AttachmentStateChangeTypeDef

AttachmentTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import AttachmentTypeDef

def get_value() -> AttachmentTypeDef:
    return {
        "id": ...,
    }
Definition
class AttachmentTypeDef(TypedDict):
    id: NotRequired[str],
    type: NotRequired[str],
    status: NotRequired[str],
    details: NotRequired[List[KeyValuePairTypeDef]],  # (1)
  1. See KeyValuePairTypeDef

ProxyConfigurationTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import ProxyConfigurationTypeDef

def get_value() -> ProxyConfigurationTypeDef:
    return {
        "containerName": ...,
    }
Definition
class ProxyConfigurationTypeDef(TypedDict):
    containerName: str,
    type: NotRequired[ProxyConfigurationTypeType],  # (1)
    properties: NotRequired[List[KeyValuePairTypeDef]],  # (2)
  1. See ProxyConfigurationTypeType
  2. See KeyValuePairTypeDef

DeleteAttributesRequestRequestTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import DeleteAttributesRequestRequestTypeDef

def get_value() -> DeleteAttributesRequestRequestTypeDef:
    return {
        "attributes": ...,
    }
Definition
class DeleteAttributesRequestRequestTypeDef(TypedDict):
    attributes: Sequence[AttributeTypeDef],  # (1)
    cluster: NotRequired[str],
  1. See AttributeTypeDef

PutAttributesRequestRequestTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import PutAttributesRequestRequestTypeDef

def get_value() -> PutAttributesRequestRequestTypeDef:
    return {
        "attributes": ...,
    }
Definition
class PutAttributesRequestRequestTypeDef(TypedDict):
    attributes: Sequence[AttributeTypeDef],  # (1)
    cluster: NotRequired[str],
  1. See AttributeTypeDef

AutoScalingGroupProviderTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import AutoScalingGroupProviderTypeDef

def get_value() -> AutoScalingGroupProviderTypeDef:
    return {
        "autoScalingGroupArn": ...,
    }
Definition
class AutoScalingGroupProviderTypeDef(TypedDict):
    autoScalingGroupArn: str,
    managedScaling: NotRequired[ManagedScalingTypeDef],  # (1)
    managedTerminationProtection: NotRequired[ManagedTerminationProtectionType],  # (2)
  1. See ManagedScalingTypeDef
  2. See ManagedTerminationProtectionType

AutoScalingGroupProviderUpdateTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import AutoScalingGroupProviderUpdateTypeDef

def get_value() -> AutoScalingGroupProviderUpdateTypeDef:
    return {
        "managedScaling": ...,
    }
Definition
class AutoScalingGroupProviderUpdateTypeDef(TypedDict):
    managedScaling: NotRequired[ManagedScalingTypeDef],  # (1)
    managedTerminationProtection: NotRequired[ManagedTerminationProtectionType],  # (2)
  1. See ManagedScalingTypeDef
  2. See ManagedTerminationProtectionType

NetworkConfigurationTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import NetworkConfigurationTypeDef

def get_value() -> NetworkConfigurationTypeDef:
    return {
        "awsvpcConfiguration": ...,
    }
Definition
class NetworkConfigurationTypeDef(TypedDict):
    awsvpcConfiguration: NotRequired[AwsVpcConfigurationTypeDef],  # (1)
  1. See AwsVpcConfigurationTypeDef

PutClusterCapacityProvidersRequestRequestTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import PutClusterCapacityProvidersRequestRequestTypeDef

def get_value() -> PutClusterCapacityProvidersRequestRequestTypeDef:
    return {
        "cluster": ...,
        "capacityProviders": ...,
        "defaultCapacityProviderStrategy": ...,
    }
Definition
class PutClusterCapacityProvidersRequestRequestTypeDef(TypedDict):
    cluster: str,
    capacityProviders: Sequence[str],
    defaultCapacityProviderStrategy: Sequence[CapacityProviderStrategyItemTypeDef],  # (1)
  1. See CapacityProviderStrategyItemTypeDef

TagResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_ecs.type_defs import TagResourceRequestRequestTypeDef

def get_value() -> TagResourceRequestRequestTypeDef:
    return {
</