ECS module
Index > ECS
Auto-generated documentation for ECS type annotations stubs module mypy-boto3-ecs.
How to install
VSCode extension
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and ECS
.
From PyPI with pip
Install boto3-stubs
for ECS
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[ecs]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[ecs]'
# standalone installation
python -m pip install mypy-boto3-ecs
How to uninstall
Usage
Code samples can be found in Examples.
ECSClient
Type annotations and code completion for boto3.client("ecs")
as ECSClient
boto3 documentation
Usage example
from boto3.session import Session
from mypy_boto3_ecs.client import ECSClient
def get_client() -> ECSClient:
return Session().client("ecs")
Paginators
Type annotations and code completion for paginators
from boto3.client("ecs").get_paginator("...")
.
Usage example
from boto3.session import Session
from mypy_boto3_ecs.paginator import ListAccountSettingsPaginator
def get_list_account_settings_paginator() -> ListAccountSettingsPaginator:
return Session().client("ecs").get_paginator("list_account_settings"))
- ListAccountSettingsPaginator
- ListAttributesPaginator
- ListClustersPaginator
- ListContainerInstancesPaginator
- ListServicesPaginator
- ListServicesByNamespacePaginator
- ListTaskDefinitionFamiliesPaginator
- ListTaskDefinitionsPaginator
- ListTasksPaginator
Waiters
Type annotations and code completion for waiters
from boto3.client("ecs").get_waiter("...")
.
Usage example
from boto3.session import Session
from mypy_boto3_ecs.waiter import ServicesInactiveWaiter
def get_services_inactive_waiter() -> ServicesInactiveWaiter:
return Session().client("ecs").get_waiter("services_inactive")
Literals
Type annotations for literals used in methods and schemas.
Usage example
from mypy_boto3_ecs.literals import AgentUpdateStatusType
def get_value() -> AgentUpdateStatusType:
return "FAILED"
- AgentUpdateStatusType
- ApplicationProtocolType
- AssignPublicIpType
- CPUArchitectureType
- CapacityProviderFieldType
- CapacityProviderStatusType
- CapacityProviderUpdateStatusType
- ClusterFieldType
- ClusterSettingNameType
- CompatibilityType
- ConnectivityType
- ContainerConditionType
- ContainerInstanceFieldType
- ContainerInstanceStatusType
- DeploymentControllerTypeType
- DeploymentRolloutStateType
- DesiredStatusType
- DeviceCgroupPermissionType
- EFSAuthorizationConfigIAMType
- EFSTransitEncryptionType
- EnvironmentFileTypeType
- ExecuteCommandLoggingType
- FirelensConfigurationTypeType
- HealthStatusType
- InstanceHealthCheckStateType
- InstanceHealthCheckTypeType
- IpcModeType
- LaunchTypeType
- ListAccountSettingsPaginatorName
- ListAttributesPaginatorName
- ListClustersPaginatorName
- ListContainerInstancesPaginatorName
- ListServicesByNamespacePaginatorName
- ListServicesPaginatorName
- ListTaskDefinitionFamiliesPaginatorName
- ListTaskDefinitionsPaginatorName
- ListTasksPaginatorName
- LogDriverType
- ManagedAgentNameType
- ManagedScalingStatusType
- ManagedTerminationProtectionType
- NetworkModeType
- OSFamilyType
- PidModeType
- PlacementConstraintTypeType
- PlacementStrategyTypeType
- PlatformDeviceTypeType
- PropagateTagsType
- ProxyConfigurationTypeType
- ResourceTypeType
- ScaleUnitType
- SchedulingStrategyType
- ScopeType
- ServiceFieldType
- ServicesInactiveWaiterName
- ServicesStableWaiterName
- SettingNameType
- SortOrderType
- StabilityStatusType
- TargetTypeType
- TaskDefinitionFamilyStatusType
- TaskDefinitionFieldType
- TaskDefinitionPlacementConstraintTypeType
- TaskDefinitionStatusType
- TaskFieldType
- TaskSetFieldType
- TaskStopCodeType
- TasksRunningWaiterName
- TasksStoppedWaiterName
- TransportProtocolType
- UlimitNameType
- ECSServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- WaiterName
- RegionName
Typed dictionaries
Type annotations for typed dictionaries used in methods and schema.
Usage example
from mypy_boto3_ecs.type_defs import AttachmentStateChangeTypeDef
def get_value() -> AttachmentStateChangeTypeDef:
return {
"attachmentArn": ...,
"status": ...,
}
- AttachmentStateChangeTypeDef
- KeyValuePairTypeDef
- AttributeTypeDef
- ManagedScalingTypeDef
- AwsVpcConfigurationTypeDef
- CapacityProviderStrategyItemTypeDef
- TagTypeDef
- ClusterServiceConnectDefaultsRequestTypeDef
- ClusterServiceConnectDefaultsTypeDef
- ClusterSettingTypeDef
- ContainerDependencyTypeDef
- EnvironmentFileTypeDef
- FirelensConfigurationTypeDef
- HealthCheckTypeDef
- HostEntryTypeDef
- MountPointTypeDef
- PortMappingTypeDef
- RepositoryCredentialsTypeDef
- ResourceRequirementTypeDef
- SecretTypeDef
- SystemControlTypeDef
- UlimitTypeDef
- VolumeFromTypeDef
- InstanceHealthCheckResultTypeDef
- ResourceTypeDef
- VersionInfoTypeDef
- NetworkBindingTypeDef
- ManagedAgentTypeDef
- NetworkInterfaceTypeDef
- ResponseMetadataTypeDef
- DeploymentControllerTypeDef
- LoadBalancerTypeDef
- PlacementConstraintTypeDef
- PlacementStrategyTypeDef
- ServiceRegistryTypeDef
- ScaleTypeDef
- DeleteAccountSettingRequestRequestTypeDef
- SettingTypeDef
- DeleteCapacityProviderRequestRequestTypeDef
- DeleteClusterRequestRequestTypeDef
- DeleteServiceRequestRequestTypeDef
- DeleteTaskDefinitionsRequestRequestTypeDef
- FailureTypeDef
- DeleteTaskSetRequestRequestTypeDef
- DeploymentAlarmsTypeDef
- DeploymentCircuitBreakerTypeDef
- ServiceConnectServiceResourceTypeDef
- DeregisterContainerInstanceRequestRequestTypeDef
- DeregisterTaskDefinitionRequestRequestTypeDef
- DescribeCapacityProvidersRequestRequestTypeDef
- DescribeClustersRequestRequestTypeDef
- DescribeContainerInstancesRequestRequestTypeDef
- DescribeServicesRequestRequestTypeDef
- WaiterConfigTypeDef
- DescribeTaskDefinitionRequestRequestTypeDef
- DescribeTaskSetsRequestRequestTypeDef
- DescribeTasksRequestRequestTypeDef
- DeviceTypeDef
- DiscoverPollEndpointRequestRequestTypeDef
- DockerVolumeConfigurationTypeDef
- EFSAuthorizationConfigTypeDef
- EphemeralStorageTypeDef
- ExecuteCommandLogConfigurationTypeDef
- ExecuteCommandRequestRequestTypeDef
- SessionTypeDef
- FSxWindowsFileServerAuthorizationConfigTypeDef
- GetTaskProtectionRequestRequestTypeDef
- ProtectedTaskTypeDef
- HostVolumePropertiesTypeDef
- InferenceAcceleratorOverrideTypeDef
- InferenceAcceleratorTypeDef
- KernelCapabilitiesTypeDef
- TmpfsTypeDef
- PaginatorConfigTypeDef
- ListAccountSettingsRequestRequestTypeDef
- ListAttributesRequestRequestTypeDef
- ListClustersRequestRequestTypeDef
- ListContainerInstancesRequestRequestTypeDef
- ListServicesByNamespaceRequestRequestTypeDef
- ListServicesRequestRequestTypeDef
- ListTagsForResourceRequestRequestTypeDef
- ListTaskDefinitionFamiliesRequestRequestTypeDef
- ListTaskDefinitionsRequestRequestTypeDef
- ListTasksRequestRequestTypeDef
- ManagedAgentStateChangeTypeDef
- PlatformDeviceTypeDef
- PutAccountSettingDefaultRequestRequestTypeDef
- PutAccountSettingRequestRequestTypeDef
- RuntimePlatformTypeDef
- TaskDefinitionPlacementConstraintTypeDef
- ServiceConnectClientAliasTypeDef
- ServiceEventTypeDef
- StopTaskRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- UpdateContainerAgentRequestRequestTypeDef
- UpdateContainerInstancesStateRequestRequestTypeDef
- UpdateServicePrimaryTaskSetRequestRequestTypeDef
- UpdateTaskProtectionRequestRequestTypeDef
- SubmitAttachmentStateChangesRequestRequestTypeDef
- AttachmentTypeDef
- ProxyConfigurationTypeDef
- DeleteAttributesRequestRequestTypeDef
- PutAttributesRequestRequestTypeDef
- AutoScalingGroupProviderTypeDef
- AutoScalingGroupProviderUpdateTypeDef
- NetworkConfigurationTypeDef
- PutClusterCapacityProvidersRequestRequestTypeDef
- TagResourceRequestRequestTypeDef
- UpdateClusterSettingsRequestRequestTypeDef
- ContainerOverrideTypeDef
- LogConfigurationTypeDef
- ContainerInstanceHealthStatusTypeDef
- ContainerStateChangeTypeDef
- SubmitContainerStateChangeRequestRequestTypeDef
- ContainerTypeDef
- DeleteAttributesResponseTypeDef
- DiscoverPollEndpointResponseTypeDef
- ListAttributesResponseTypeDef
- ListClustersResponseTypeDef
- ListContainerInstancesResponseTypeDef
- ListServicesByNamespaceResponseTypeDef
- ListServicesResponseTypeDef
- ListTagsForResourceResponseTypeDef
- ListTaskDefinitionFamiliesResponseTypeDef
- ListTaskDefinitionsResponseTypeDef
- ListTasksResponseTypeDef
- PutAttributesResponseTypeDef
- SubmitAttachmentStateChangesResponseTypeDef
- SubmitContainerStateChangeResponseTypeDef
- SubmitTaskStateChangeResponseTypeDef
- UpdateTaskSetRequestRequestTypeDef
- DeleteAccountSettingResponseTypeDef
- ListAccountSettingsResponseTypeDef
- PutAccountSettingDefaultResponseTypeDef
- PutAccountSettingResponseTypeDef
- DeploymentConfigurationTypeDef
- DescribeServicesRequestServicesInactiveWaitTypeDef
- DescribeServicesRequestServicesStableWaitTypeDef
- DescribeTasksRequestTasksRunningWaitTypeDef
- DescribeTasksRequestTasksStoppedWaitTypeDef
- EFSVolumeConfigurationTypeDef
- ExecuteCommandConfigurationTypeDef
- ExecuteCommandResponseTypeDef
- FSxWindowsFileServerVolumeConfigurationTypeDef
- GetTaskProtectionResponseTypeDef
- UpdateTaskProtectionResponseTypeDef
- LinuxParametersTypeDef
- ListAccountSettingsRequestListAccountSettingsPaginateTypeDef
- ListAttributesRequestListAttributesPaginateTypeDef
- ListClustersRequestListClustersPaginateTypeDef
- ListContainerInstancesRequestListContainerInstancesPaginateTypeDef
- ListServicesByNamespaceRequestListServicesByNamespacePaginateTypeDef
- ListServicesRequestListServicesPaginateTypeDef
- ListTaskDefinitionFamiliesRequestListTaskDefinitionFamiliesPaginateTypeDef
- ListTaskDefinitionsRequestListTaskDefinitionsPaginateTypeDef
- ListTasksRequestListTasksPaginateTypeDef
- RegisterContainerInstanceRequestRequestTypeDef
- ServiceConnectServiceTypeDef
- CapacityProviderTypeDef
- CreateCapacityProviderRequestRequestTypeDef
- UpdateCapacityProviderRequestRequestTypeDef
- CreateTaskSetRequestRequestTypeDef
- TaskSetTypeDef
- TaskOverrideTypeDef
- ContainerInstanceTypeDef
- SubmitTaskStateChangeRequestRequestTypeDef
- ClusterConfigurationTypeDef
- VolumeTypeDef
- ContainerDefinitionTypeDef
- ServiceConnectConfigurationTypeDef
- CreateCapacityProviderResponseTypeDef
- DeleteCapacityProviderResponseTypeDef
- DescribeCapacityProvidersResponseTypeDef
- UpdateCapacityProviderResponseTypeDef
- CreateTaskSetResponseTypeDef
- DeleteTaskSetResponseTypeDef
- DescribeTaskSetsResponseTypeDef
- UpdateServicePrimaryTaskSetResponseTypeDef
- UpdateTaskSetResponseTypeDef
- RunTaskRequestRequestTypeDef
- StartTaskRequestRequestTypeDef
- TaskTypeDef
- DeregisterContainerInstanceResponseTypeDef
- DescribeContainerInstancesResponseTypeDef
- RegisterContainerInstanceResponseTypeDef
- UpdateContainerAgentResponseTypeDef
- UpdateContainerInstancesStateResponseTypeDef
- ClusterTypeDef
- CreateClusterRequestRequestTypeDef
- UpdateClusterRequestRequestTypeDef
- RegisterTaskDefinitionRequestRequestTypeDef
- TaskDefinitionTypeDef
- CreateServiceRequestRequestTypeDef
- DeploymentTypeDef
- UpdateServiceRequestRequestTypeDef
- DescribeTasksResponseTypeDef
- RunTaskResponseTypeDef
- StartTaskResponseTypeDef
- StopTaskResponseTypeDef
- CreateClusterResponseTypeDef
- DeleteClusterResponseTypeDef
- DescribeClustersResponseTypeDef
- PutClusterCapacityProvidersResponseTypeDef
- UpdateClusterResponseTypeDef
- UpdateClusterSettingsResponseTypeDef
- DeleteTaskDefinitionsResponseTypeDef
- DeregisterTaskDefinitionResponseTypeDef
- DescribeTaskDefinitionResponseTypeDef
- RegisterTaskDefinitionResponseTypeDef
- ServiceTypeDef
- CreateServiceResponseTypeDef
- DeleteServiceResponseTypeDef
- DescribeServicesResponseTypeDef
- UpdateServiceResponseTypeDef