Skip to content

ECSClient

Index > ECS > ECSClient

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

ECSClient

Type annotations and code completion for boto3.client("ecs"). boto3 documentation

Usage example
from boto3.session import Session
from mypy_boto3_ecs.client import ECSClient

def get_ecs_client() -> ECSClient:
    return Session().client("ecs")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("ecs").exceptions structure.

Usage example
client = boto3.client("ecs")

try:
    do_something(client)
except (
    client.AccessDeniedException,
    client.AttributeLimitExceededException,
    client.BlockedException,
    client.ClientError,
    client.ClientException,
    client.ClusterContainsContainerInstancesException,
    client.ClusterContainsServicesException,
    client.ClusterContainsTasksException,
    client.ClusterNotFoundException,
    client.InvalidParameterException,
    client.LimitExceededException,
    client.MissingVersionException,
    client.NoUpdateAvailableException,
    client.PlatformTaskDefinitionIncompatibilityException,
    client.PlatformUnknownException,
    client.ResourceInUseException,
    client.ResourceNotFoundException,
    client.ServerException,
    client.ServiceNotActiveException,
    client.ServiceNotFoundException,
    client.TargetNotConnectedException,
    client.TargetNotFoundException,
    client.TaskSetNotFoundException,
    client.UnsupportedFeatureException,
    client.UpdateInProgressException,
) as e:
    print(e)
Type checking example
from mypy_boto3_ecs.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("ecs").can_paginate method. boto3 documentation

Method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("ecs").close method. boto3 documentation

Method definition
def close(
    self,
) -> None:
    ...

create_capacity_provider

Creates a new capacity provider.

Type annotations and code completion for boto3.client("ecs").create_capacity_provider method. boto3 documentation

Method definition
def create_capacity_provider(
    self,
    *,
    name: str,
    autoScalingGroupProvider: AutoScalingGroupProviderTypeDef,  # (1)
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateCapacityProviderResponseTypeDef:  # (3)
    ...
  1. See AutoScalingGroupProviderTypeDef
  2. See TagTypeDef
  3. See CreateCapacityProviderResponseTypeDef
Usage example with kwargs
kwargs: CreateCapacityProviderRequestRequestTypeDef = {  # (1)
    "name": ...,
    "autoScalingGroupProvider": ...,
}

parent.create_capacity_provider(**kwargs)
  1. See CreateCapacityProviderRequestRequestTypeDef

create_cluster

Creates a new Amazon ECS cluster.

Type annotations and code completion for boto3.client("ecs").create_cluster method. boto3 documentation

Method definition
def create_cluster(
    self,
    *,
    clusterName: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (1)
    settings: Sequence[ClusterSettingTypeDef] = ...,  # (2)
    configuration: ClusterConfigurationTypeDef = ...,  # (3)
    capacityProviders: Sequence[str] = ...,
    defaultCapacityProviderStrategy: Sequence[CapacityProviderStrategyItemTypeDef] = ...,  # (4)
) -> CreateClusterResponseTypeDef:  # (5)
    ...
  1. See TagTypeDef
  2. See ClusterSettingTypeDef
  3. See ClusterConfigurationTypeDef
  4. See CapacityProviderStrategyItemTypeDef
  5. See CreateClusterResponseTypeDef
Usage example with kwargs
kwargs: CreateClusterRequestRequestTypeDef = {  # (1)
    "clusterName": ...,
}

parent.create_cluster(**kwargs)
  1. See CreateClusterRequestRequestTypeDef

create_service

Runs and maintains your desired number of tasks from a specified task definition.

Type annotations and code completion for boto3.client("ecs").create_service method. boto3 documentation

Method definition
def create_service(
    self,
    *,
    serviceName: str,
    cluster: str = ...,
    taskDefinition: str = ...,
    loadBalancers: Sequence[LoadBalancerTypeDef] = ...,  # (1)
    serviceRegistries: Sequence[ServiceRegistryTypeDef] = ...,  # (2)
    desiredCount: int = ...,
    clientToken: str = ...,
    launchType: LaunchTypeType = ...,  # (3)
    capacityProviderStrategy: Sequence[CapacityProviderStrategyItemTypeDef] = ...,  # (4)
    platformVersion: str = ...,
    role: str = ...,
    deploymentConfiguration: DeploymentConfigurationTypeDef = ...,  # (5)
    placementConstraints: Sequence[PlacementConstraintTypeDef] = ...,  # (6)
    placementStrategy: Sequence[PlacementStrategyTypeDef] = ...,  # (7)
    networkConfiguration: NetworkConfigurationTypeDef = ...,  # (8)
    healthCheckGracePeriodSeconds: int = ...,
    schedulingStrategy: SchedulingStrategyType = ...,  # (9)
    deploymentController: DeploymentControllerTypeDef = ...,  # (10)
    tags: Sequence[TagTypeDef] = ...,  # (11)
    enableECSManagedTags: bool = ...,
    propagateTags: PropagateTagsType = ...,  # (12)
    enableExecuteCommand: bool = ...,
) -> CreateServiceResponseTypeDef:  # (13)
    ...
  1. See LoadBalancerTypeDef
  2. See ServiceRegistryTypeDef
  3. See LaunchTypeType
  4. See CapacityProviderStrategyItemTypeDef
  5. See DeploymentConfigurationTypeDef
  6. See PlacementConstraintTypeDef
  7. See PlacementStrategyTypeDef
  8. See NetworkConfigurationTypeDef
  9. See SchedulingStrategyType
  10. See DeploymentControllerTypeDef
  11. See TagTypeDef
  12. See PropagateTagsType
  13. See CreateServiceResponseTypeDef
Usage example with kwargs
kwargs: CreateServiceRequestRequestTypeDef = {  # (1)
    "serviceName": ...,
}

parent.create_service(**kwargs)
  1. See CreateServiceRequestRequestTypeDef

create_task_set

Create a task set in the specified cluster and service.

Type annotations and code completion for boto3.client("ecs").create_task_set method. boto3 documentation

Method definition
def create_task_set(
    self,
    *,
    service: str,
    cluster: str,
    taskDefinition: str,
    externalId: str = ...,
    networkConfiguration: NetworkConfigurationTypeDef = ...,  # (1)
    loadBalancers: Sequence[LoadBalancerTypeDef] = ...,  # (2)
    serviceRegistries: Sequence[ServiceRegistryTypeDef] = ...,  # (3)
    launchType: LaunchTypeType = ...,  # (4)
    capacityProviderStrategy: Sequence[CapacityProviderStrategyItemTypeDef] = ...,  # (5)
    platformVersion: str = ...,
    scale: ScaleTypeDef = ...,  # (6)
    clientToken: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (7)
) -> CreateTaskSetResponseTypeDef:  # (8)
    ...
  1. See NetworkConfigurationTypeDef
  2. See LoadBalancerTypeDef
  3. See ServiceRegistryTypeDef
  4. See LaunchTypeType
  5. See CapacityProviderStrategyItemTypeDef
  6. See ScaleTypeDef
  7. See TagTypeDef
  8. See CreateTaskSetResponseTypeDef
Usage example with kwargs
kwargs: CreateTaskSetRequestRequestTypeDef = {  # (1)
    "service": ...,
    "cluster": ...,
    "taskDefinition": ...,
}

parent.create_task_set(**kwargs)
  1. See CreateTaskSetRequestRequestTypeDef

delete_account_setting

Disables an account setting for a specified IAM user, IAM role, or the root user for an account.

Type annotations and code completion for boto3.client("ecs").delete_account_setting method. boto3 documentation

Method definition
def delete_account_setting(
    self,
    *,
    name: SettingNameType,  # (1)
    principalArn: str = ...,
) -> DeleteAccountSettingResponseTypeDef:  # (2)
    ...
  1. See SettingNameType
  2. See DeleteAccountSettingResponseTypeDef
Usage example with kwargs
kwargs: DeleteAccountSettingRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.delete_account_setting(**kwargs)
  1. See DeleteAccountSettingRequestRequestTypeDef

delete_attributes

Deletes one or more custom attributes from an Amazon ECS resource.

Type annotations and code completion for boto3.client("ecs").delete_attributes method. boto3 documentation

Method definition
def delete_attributes(
    self,
    *,
    attributes: Sequence[AttributeTypeDef],  # (1)
    cluster: str = ...,
) -> DeleteAttributesResponseTypeDef:  # (2)
    ...
  1. See AttributeTypeDef
  2. See DeleteAttributesResponseTypeDef
Usage example with kwargs
kwargs: DeleteAttributesRequestRequestTypeDef = {  # (1)
    "attributes": ...,
}

parent.delete_attributes(**kwargs)
  1. See DeleteAttributesRequestRequestTypeDef

delete_capacity_provider

Deletes the specified capacity provider.

Type annotations and code completion for boto3.client("ecs").delete_capacity_provider method. boto3 documentation

Method definition
def delete_capacity_provider(
    self,
    *,
    capacityProvider: str,
) -> DeleteCapacityProviderResponseTypeDef:  # (1)
    ...
  1. See DeleteCapacityProviderResponseTypeDef
Usage example with kwargs
kwargs: DeleteCapacityProviderRequestRequestTypeDef = {  # (1)
    "capacityProvider": ...,
}

parent.delete_capacity_provider(**kwargs)
  1. See DeleteCapacityProviderRequestRequestTypeDef

delete_cluster

Deletes the specified cluster.

Type annotations and code completion for boto3.client("ecs").delete_cluster method. boto3 documentation

Method definition
def delete_cluster(
    self,
    *,
    cluster: str,
) -> DeleteClusterResponseTypeDef:  # (1)
    ...
  1. See DeleteClusterResponseTypeDef
Usage example with kwargs
kwargs: DeleteClusterRequestRequestTypeDef = {  # (1)
    "cluster": ...,
}

parent.delete_cluster(**kwargs)
  1. See DeleteClusterRequestRequestTypeDef

delete_service

Deletes a specified service within a cluster.

Type annotations and code completion for boto3.client("ecs").delete_service method. boto3 documentation

Method definition
def delete_service(
    self,
    *,
    service: str,
    cluster: str = ...,
    force: bool = ...,
) -> DeleteServiceResponseTypeDef:  # (1)
    ...
  1. See DeleteServiceResponseTypeDef
Usage example with kwargs
kwargs: DeleteServiceRequestRequestTypeDef = {  # (1)
    "service": ...,
}

parent.delete_service(**kwargs)
  1. See DeleteServiceRequestRequestTypeDef

delete_task_set

Deletes a specified task set within a service.

Type annotations and code completion for boto3.client("ecs").delete_task_set method. boto3 documentation

Method definition
def delete_task_set(
    self,
    *,
    cluster: str,
    service: str,
    taskSet: str,
    force: bool = ...,
) -> DeleteTaskSetResponseTypeDef:  # (1)
    ...
  1. See DeleteTaskSetResponseTypeDef
Usage example with kwargs
kwargs: DeleteTaskSetRequestRequestTypeDef = {  # (1)
    "cluster": ...,
    "service": ...,
    "taskSet": ...,
}

parent.delete_task_set(**kwargs)
  1. See DeleteTaskSetRequestRequestTypeDef

deregister_container_instance

Deregisters an Amazon ECS container instance from the specified cluster.

Type annotations and code completion for boto3.client("ecs").deregister_container_instance method. boto3 documentation

Method definition
def deregister_container_instance(
    self,
    *,
    containerInstance: str,
    cluster: str = ...,
    force: bool = ...,
) -> DeregisterContainerInstanceResponseTypeDef:  # (1)
    ...
  1. See DeregisterContainerInstanceResponseTypeDef
Usage example with kwargs
kwargs: DeregisterContainerInstanceRequestRequestTypeDef = {  # (1)
    "containerInstance": ...,
}

parent.deregister_container_instance(**kwargs)
  1. See DeregisterContainerInstanceRequestRequestTypeDef

deregister_task_definition

Deregisters the specified task definition by family and revision.

Type annotations and code completion for boto3.client("ecs").deregister_task_definition method. boto3 documentation

Method definition
def deregister_task_definition(
    self,
    *,
    taskDefinition: str,
) -> DeregisterTaskDefinitionResponseTypeDef:  # (1)
    ...
  1. See DeregisterTaskDefinitionResponseTypeDef
Usage example with kwargs
kwargs: DeregisterTaskDefinitionRequestRequestTypeDef = {  # (1)
    "taskDefinition": ...,
}

parent.deregister_task_definition(**kwargs)
  1. See DeregisterTaskDefinitionRequestRequestTypeDef

describe_capacity_providers

Describes one or more of your capacity providers.

Type annotations and code completion for boto3.client("ecs").describe_capacity_providers method. boto3 documentation

Method definition
def describe_capacity_providers(
    self,
    *,
    capacityProviders: Sequence[str] = ...,
    include: Sequence[CapacityProviderFieldType] = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> DescribeCapacityProvidersResponseTypeDef:  # (2)
    ...
  1. See CapacityProviderFieldType
  2. See DescribeCapacityProvidersResponseTypeDef
Usage example with kwargs
kwargs: DescribeCapacityProvidersRequestRequestTypeDef = {  # (1)
    "capacityProviders": ...,
}

parent.describe_capacity_providers(**kwargs)
  1. See DescribeCapacityProvidersRequestRequestTypeDef

describe_clusters

Describes one or more of your clusters.

Type annotations and code completion for boto3.client("ecs").describe_clusters method. boto3 documentation

Method definition
def describe_clusters(
    self,
    *,
    clusters: Sequence[str] = ...,
    include: Sequence[ClusterFieldType] = ...,  # (1)
) -> DescribeClustersResponseTypeDef:  # (2)
    ...
  1. See ClusterFieldType
  2. See DescribeClustersResponseTypeDef
Usage example with kwargs
kwargs: DescribeClustersRequestRequestTypeDef = {  # (1)
    "clusters": ...,
}

parent.describe_clusters(**kwargs)
  1. See DescribeClustersRequestRequestTypeDef

describe_container_instances

Describes one or more container instances.

Type annotations and code completion for boto3.client("ecs").describe_container_instances method. boto3 documentation

Method definition
def describe_container_instances(
    self,
    *,
    containerInstances: Sequence[str],
    cluster: str = ...,
    include: Sequence[ContainerInstanceFieldType] = ...,  # (1)
) -> DescribeContainerInstancesResponseTypeDef:  # (2)
    ...
  1. See ContainerInstanceFieldType
  2. See DescribeContainerInstancesResponseTypeDef
Usage example with kwargs
kwargs: DescribeContainerInstancesRequestRequestTypeDef = {  # (1)
    "containerInstances": ...,
}

parent.describe_container_instances(**kwargs)
  1. See DescribeContainerInstancesRequestRequestTypeDef

describe_services

Describes the specified services running in your cluster.

Type annotations and code completion for boto3.client("ecs").describe_services method. boto3 documentation

Method definition
def describe_services(
    self,
    *,
    services: Sequence[str],
    cluster: str = ...,
    include: Sequence[ServiceFieldType] = ...,  # (1)
) -> DescribeServicesResponseTypeDef:  # (2)
    ...
  1. See ServiceFieldType
  2. See DescribeServicesResponseTypeDef
Usage example with kwargs
kwargs: DescribeServicesRequestRequestTypeDef = {  # (1)
    "services": ...,
}

parent.describe_services(**kwargs)
  1. See DescribeServicesRequestRequestTypeDef

describe_task_definition

Describes a task definition.

Type annotations and code completion for boto3.client("ecs").describe_task_definition method. boto3 documentation

Method definition
def describe_task_definition(
    self,
    *,
    taskDefinition: str,
    include: Sequence[TaskDefinitionFieldType] = ...,  # (1)
) -> DescribeTaskDefinitionResponseTypeDef:  # (2)
    ...
  1. See TaskDefinitionFieldType
  2. See DescribeTaskDefinitionResponseTypeDef
Usage example with kwargs
kwargs: DescribeTaskDefinitionRequestRequestTypeDef = {  # (1)
    "taskDefinition": ...,
}

parent.describe_task_definition(**kwargs)
  1. See DescribeTaskDefinitionRequestRequestTypeDef

describe_task_sets

Describes the task sets in the specified cluster and service.

Type annotations and code completion for boto3.client("ecs").describe_task_sets method. boto3 documentation

Method definition
def describe_task_sets(
    self,
    *,
    cluster: str,
    service: str,
    taskSets: Sequence[str] = ...,
    include: Sequence[TaskSetFieldType] = ...,  # (1)
) -> DescribeTaskSetsResponseTypeDef:  # (2)
    ...
  1. See TaskSetFieldType
  2. See DescribeTaskSetsResponseTypeDef
Usage example with kwargs
kwargs: DescribeTaskSetsRequestRequestTypeDef = {  # (1)
    "cluster": ...,
    "service": ...,
}

parent.describe_task_sets(**kwargs)
  1. See DescribeTaskSetsRequestRequestTypeDef

describe_tasks

Describes a specified task or tasks.

Type annotations and code completion for boto3.client("ecs").describe_tasks method. boto3 documentation

Method definition
def describe_tasks(
    self,
    *,
    tasks: Sequence[str],
    cluster: str = ...,
    include: Sequence[TaskFieldType] = ...,  # (1)
) -> DescribeTasksResponseTypeDef:  # (2)
    ...
  1. See TaskFieldType
  2. See DescribeTasksResponseTypeDef
Usage example with kwargs
kwargs: DescribeTasksRequestRequestTypeDef = {  # (1)
    "tasks": ...,
}

parent.describe_tasks(**kwargs)
  1. See DescribeTasksRequestRequestTypeDef

discover_poll_endpoint

.

Type annotations and code completion for boto3.client("ecs").discover_poll_endpoint method. boto3 documentation

Method definition
def discover_poll_endpoint(
    self,
    *,
    containerInstance: str = ...,
    cluster: str = ...,
) -> DiscoverPollEndpointResponseTypeDef:  # (1)
    ...
  1. See DiscoverPollEndpointResponseTypeDef
Usage example with kwargs
kwargs: DiscoverPollEndpointRequestRequestTypeDef = {  # (1)
    "containerInstance": ...,
}

parent.discover_poll_endpoint(**kwargs)
  1. See DiscoverPollEndpointRequestRequestTypeDef

execute_command

Runs a command remotely on a container within a task.

Type annotations and code completion for boto3.client("ecs").execute_command method. boto3 documentation

Method definition
def execute_command(
    self,
    *,
    command: str,
    interactive: bool,
    task: str,
    cluster: str = ...,
    container: str = ...,
) -> ExecuteCommandResponseTypeDef:  # (1)
    ...
  1. See ExecuteCommandResponseTypeDef
Usage example with kwargs
kwargs: ExecuteCommandRequestRequestTypeDef = {  # (1)
    "command": ...,
    "interactive": ...,
    "task": ...,
}

parent.execute_command(**kwargs)
  1. See ExecuteCommandRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("ecs").generate_presigned_url method. boto3 documentation

Method definition
def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

list_account_settings

Lists the account settings for a specified principal.

Type annotations and code completion for boto3.client("ecs").list_account_settings method. boto3 documentation

Method definition
def list_account_settings(
    self,
    *,
    name: SettingNameType = ...,  # (1)
    value: str = ...,
    principalArn: str = ...,
    effectiveSettings: bool = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListAccountSettingsResponseTypeDef:  # (2)
    ...
  1. See SettingNameType
  2. See ListAccountSettingsResponseTypeDef
Usage example with kwargs
kwargs: ListAccountSettingsRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.list_account_settings(**kwargs)
  1. See ListAccountSettingsRequestRequestTypeDef

list_attributes

Lists the attributes for Amazon ECS resources within a specified target type and cluster.

Type annotations and code completion for boto3.client("ecs").list_attributes method. boto3 documentation

Method definition
def list_attributes(
    self,
    *,
    targetType: TargetTypeType,  # (1)
    cluster: str = ...,
    attributeName: str = ...,
    attributeValue: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListAttributesResponseTypeDef:  # (2)
    ...
  1. See TargetTypeType
  2. See ListAttributesResponseTypeDef
Usage example with kwargs
kwargs: ListAttributesRequestRequestTypeDef = {  # (1)
    "targetType": ...,
}

parent.list_attributes(**kwargs)
  1. See ListAttributesRequestRequestTypeDef

list_clusters

Returns a list of existing clusters.

Type annotations and code completion for boto3.client("ecs").list_clusters method. boto3 documentation

Method definition
def list_clusters(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListClustersResponseTypeDef:  # (1)
    ...
  1. See ListClustersResponseTypeDef
Usage example with kwargs
kwargs: ListClustersRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_clusters(**kwargs)
  1. See ListClustersRequestRequestTypeDef

list_container_instances

Returns a list of container instances in a specified cluster.

Type annotations and code completion for boto3.client("ecs").list_container_instances method. boto3 documentation

Method definition
def list_container_instances(
    self,
    *,
    cluster: str = ...,
    filter: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
    status: ContainerInstanceStatusType = ...,  # (1)
) -> ListContainerInstancesResponseTypeDef:  # (2)
    ...
  1. See ContainerInstanceStatusType
  2. See ListContainerInstancesResponseTypeDef
Usage example with kwargs
kwargs: ListContainerInstancesRequestRequestTypeDef = {  # (1)
    "cluster": ...,
}

parent.list_container_instances(**kwargs)
  1. See ListContainerInstancesRequestRequestTypeDef

list_services

Returns a list of services.

Type annotations and code completion for boto3.client("ecs").list_services method. boto3 documentation

Method definition
def list_services(
    self,
    *,
    cluster: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
    launchType: LaunchTypeType = ...,  # (1)
    schedulingStrategy: SchedulingStrategyType = ...,  # (2)
) -> ListServicesResponseTypeDef:  # (3)
    ...
  1. See LaunchTypeType
  2. See SchedulingStrategyType
  3. See ListServicesResponseTypeDef
Usage example with kwargs
kwargs: ListServicesRequestRequestTypeDef = {  # (1)
    "cluster": ...,
}

parent.list_services(**kwargs)
  1. See ListServicesRequestRequestTypeDef

list_tags_for_resource

List the tags for an Amazon ECS resource.

Type annotations and code completion for boto3.client("ecs").list_tags_for_resource method. boto3 documentation

Method definition
def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
Usage example with kwargs
kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

list_task_definition_families

Returns a list of task definition families that are registered to your account.

Type annotations and code completion for boto3.client("ecs").list_task_definition_families method. boto3 documentation

Method definition
def list_task_definition_families(
    self,
    *,
    familyPrefix: str = ...,
    status: TaskDefinitionFamilyStatusType = ...,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListTaskDefinitionFamiliesResponseTypeDef:  # (2)
    ...
  1. See TaskDefinitionFamilyStatusType
  2. See ListTaskDefinitionFamiliesResponseTypeDef
Usage example with kwargs
kwargs: ListTaskDefinitionFamiliesRequestRequestTypeDef = {  # (1)
    "familyPrefix": ...,
}

parent.list_task_definition_families(**kwargs)
  1. See ListTaskDefinitionFamiliesRequestRequestTypeDef

list_task_definitions

Returns a list of task definitions that are registered to your account.

Type annotations and code completion for boto3.client("ecs").list_task_definitions method. boto3 documentation

Method definition
def list_task_definitions(
    self,
    *,
    familyPrefix: str = ...,
    status: TaskDefinitionStatusType = ...,  # (1)
    sort: SortOrderType = ...,  # (2)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListTaskDefinitionsResponseTypeDef:  # (3)
    ...
  1. See TaskDefinitionStatusType
  2. See SortOrderType
  3. See ListTaskDefinitionsResponseTypeDef
Usage example with kwargs
kwargs: ListTaskDefinitionsRequestRequestTypeDef = {  # (1)
    "familyPrefix": ...,
}

parent.list_task_definitions(**kwargs)
  1. See ListTaskDefinitionsRequestRequestTypeDef

list_tasks

Returns a list of tasks.

Type annotations and code completion for boto3.client("ecs").list_tasks method. boto3 documentation

Method definition
def list_tasks(
    self,
    *,
    cluster: str = ...,
    containerInstance: str = ...,
    family: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
    startedBy: str = ...,
    serviceName: str = ...,
    desiredStatus: DesiredStatusType = ...,  # (1)
    launchType: LaunchTypeType = ...,  # (2)
) -> ListTasksResponseTypeDef:  # (3)
    ...
  1. See DesiredStatusType
  2. See LaunchTypeType
  3. See ListTasksResponseTypeDef
Usage example with kwargs
kwargs: ListTasksRequestRequestTypeDef = {  # (1)
    "cluster": ...,
}

parent.list_tasks(**kwargs)
  1. See ListTasksRequestRequestTypeDef

put_account_setting

Modifies an account setting.

Type annotations and code completion for boto3.client("ecs").put_account_setting method. boto3 documentation

Method definition
def put_account_setting(
    self,
    *,
    name: SettingNameType,  # (1)
    value: str,
    principalArn: str = ...,
) -> PutAccountSettingResponseTypeDef:  # (2)
    ...
  1. See SettingNameType
  2. See PutAccountSettingResponseTypeDef
Usage example with kwargs
kwargs: PutAccountSettingRequestRequestTypeDef = {  # (1)
    "name": ...,
    "value": ...,
}

parent.put_account_setting(**kwargs)
  1. See PutAccountSettingRequestRequestTypeDef

put_account_setting_default

Modifies an account setting for all IAM users on an account for whom no individual account setting has been specified.

Type annotations and code completion for boto3.client("ecs").put_account_setting_default method. boto3 documentation

Method definition
def put_account_setting_default(
    self,
    *,
    name: SettingNameType,  # (1)
    value: str,
) -> PutAccountSettingDefaultResponseTypeDef:  # (2)
    ...
  1. See SettingNameType
  2. See PutAccountSettingDefaultResponseTypeDef
Usage example with kwargs
kwargs: PutAccountSettingDefaultRequestRequestTypeDef = {  # (1)
    "name": ...,
    "value": ...,
}

parent.put_account_setting_default(**kwargs)
  1. See PutAccountSettingDefaultRequestRequestTypeDef

put_attributes

Create or update an attribute on an Amazon ECS resource.

Type annotations and code completion for boto3.client("ecs").put_attributes method. boto3 documentation

Method definition
def put_attributes(
    self,
    *,
    attributes: Sequence[AttributeTypeDef],  # (1)
    cluster: str = ...,
) -> PutAttributesResponseTypeDef:  # (2)
    ...
  1. See AttributeTypeDef
  2. See PutAttributesResponseTypeDef
Usage example with kwargs
kwargs: PutAttributesRequestRequestTypeDef = {  # (1)
    "attributes": ...,
}

parent.put_attributes(**kwargs)
  1. See PutAttributesRequestRequestTypeDef

put_cluster_capacity_providers

Modifies the available capacity providers and the default capacity provider strategy for a cluster.

Type annotations and code completion for boto3.client("ecs").put_cluster_capacity_providers method. boto3 documentation

Method definition
def put_cluster_capacity_providers(
    self,
    *,
    cluster: str,
    capacityProviders: Sequence[str],
    defaultCapacityProviderStrategy: Sequence[CapacityProviderStrategyItemTypeDef],  # (1)
) -> PutClusterCapacityProvidersResponseTypeDef:  # (2)
    ...
  1. See CapacityProviderStrategyItemTypeDef
  2. See PutClusterCapacityProvidersResponseTypeDef
Usage example with kwargs
kwargs: PutClusterCapacityProvidersRequestRequestTypeDef = {  # (1)
    "cluster": ...,
    "capacityProviders": ...,
    "defaultCapacityProviderStrategy": ...,
}

parent.put_cluster_capacity_providers(**kwargs)
  1. See PutClusterCapacityProvidersRequestRequestTypeDef

register_container_instance

.

Type annotations and code completion for boto3.client("ecs").register_container_instance method. boto3 documentation

Method definition
def register_container_instance(
    self,
    *,
    cluster: str = ...,
    instanceIdentityDocument: str = ...,
    instanceIdentityDocumentSignature: str = ...,
    totalResources: Sequence[ResourceTypeDef] = ...,  # (1)
    versionInfo: VersionInfoTypeDef = ...,  # (2)
    containerInstanceArn: str = ...,
    attributes: Sequence[AttributeTypeDef] = ...,  # (3)
    platformDevices: Sequence[PlatformDeviceTypeDef] = ...,  # (4)
    tags: Sequence[TagTypeDef] = ...,  # (5)
) -> RegisterContainerInstanceResponseTypeDef:  # (6)
    ...
  1. See ResourceTypeDef
  2. See VersionInfoTypeDef
  3. See AttributeTypeDef
  4. See PlatformDeviceTypeDef
  5. See TagTypeDef
  6. See RegisterContainerInstanceResponseTypeDef
Usage example with kwargs
kwargs: RegisterContainerInstanceRequestRequestTypeDef = {  # (1)
    "cluster": ...,
}

parent.register_container_instance(**kwargs)
  1. See RegisterContainerInstanceRequestRequestTypeDef

register_task_definition

Registers a new task definition from the supplied family and containerDefinitions.

Type annotations and code completion for boto3.client("ecs").register_task_definition method. boto3 documentation

Method definition
def register_task_definition(
    self,
    *,
    family: str,
    containerDefinitions: Sequence[ContainerDefinitionTypeDef],  # (1)
    taskRoleArn: str = ...,
    executionRoleArn: str = ...,
    networkMode: NetworkModeType = ...,  # (2)
    volumes: Sequence[VolumeTypeDef] = ...,  # (3)
    placementConstraints: Sequence[TaskDefinitionPlacementConstraintTypeDef] = ...,  # (4)
    requiresCompatibilities: Sequence[CompatibilityType] = ...,  # (5)
    cpu: str = ...,
    memory: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (6)
    pidMode: PidModeType = ...,  # (7)
    ipcMode: IpcModeType = ...,  # (8)
    proxyConfiguration: ProxyConfigurationTypeDef = ...,  # (9)
    inferenceAccelerators: Sequence[InferenceAcceleratorTypeDef] = ...,  # (10)
    ephemeralStorage: EphemeralStorageTypeDef = ...,  # (11)
    runtimePlatform: RuntimePlatformTypeDef = ...,  # (12)
) -> RegisterTaskDefinitionResponseTypeDef:  # (13)
    ...
  1. See ContainerDefinitionTypeDef
  2. See NetworkModeType
  3. See VolumeTypeDef
  4. See TaskDefinitionPlacementConstraintTypeDef
  5. See CompatibilityType
  6. See TagTypeDef
  7. See PidModeType
  8. See IpcModeType
  9. See ProxyConfigurationTypeDef
  10. See InferenceAcceleratorTypeDef
  11. See EphemeralStorageTypeDef
  12. See RuntimePlatformTypeDef
  13. See RegisterTaskDefinitionResponseTypeDef
Usage example with kwargs
kwargs: RegisterTaskDefinitionRequestRequestTypeDef = {  # (1)
    "family": ...,
    "containerDefinitions": ...,
}

parent.register_task_definition(**kwargs)
  1. See RegisterTaskDefinitionRequestRequestTypeDef

run_task

Starts a new task using the specified task definition.

Type annotations and code completion for boto3.client("ecs").run_task method. boto3 documentation

Method definition
def run_task(
    self,
    *,
    taskDefinition: str,
    capacityProviderStrategy: Sequence[CapacityProviderStrategyItemTypeDef] = ...,  # (1)
    cluster: str = ...,
    count: int = ...,
    enableECSManagedTags: bool = ...,
    enableExecuteCommand: bool = ...,
    group: str = ...,
    launchType: LaunchTypeType = ...,  # (2)
    networkConfiguration: NetworkConfigurationTypeDef = ...,  # (3)
    overrides: TaskOverrideTypeDef = ...,  # (4)
    placementConstraints: Sequence[PlacementConstraintTypeDef] = ...,  # (5)
    placementStrategy: Sequence[PlacementStrategyTypeDef] = ...,  # (6)
    platformVersion: str = ...,
    propagateTags: PropagateTagsType = ...,  # (7)
    referenceId: str = ...,
    startedBy: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (8)
) -> RunTaskResponseTypeDef:  # (9)
    ...
  1. See CapacityProviderStrategyItemTypeDef
  2. See LaunchTypeType
  3. See NetworkConfigurationTypeDef
  4. See TaskOverrideTypeDef
  5. See PlacementConstraintTypeDef
  6. See PlacementStrategyTypeDef
  7. See PropagateTagsType
  8. See TagTypeDef
  9. See RunTaskResponseTypeDef
Usage example with kwargs
kwargs: RunTaskRequestRequestTypeDef = {  # (1)
    "taskDefinition": ...,
}

parent.run_task(**kwargs)
  1. See RunTaskRequestRequestTypeDef

start_task

Starts a new task from the specified task definition on the specified container instance or instances.

Type annotations and code completion for boto3.client("ecs").start_task method. boto3 documentation

Method definition
def start_task(
    self,
    *,
    containerInstances: Sequence[str],
    taskDefinition: str,
    cluster: str = ...,
    enableECSManagedTags: bool = ...,
    enableExecuteCommand: bool = ...,
    group: str = ...,
    networkConfiguration: NetworkConfigurationTypeDef = ...,  # (1)
    overrides: TaskOverrideTypeDef = ...,  # (2)
    propagateTags: PropagateTagsType = ...,  # (3)
    referenceId: str = ...,
    startedBy: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (4)
) -> StartTaskResponseTypeDef:  # (5)
    ...
  1. See NetworkConfigurationTypeDef
  2. See TaskOverrideTypeDef
  3. See PropagateTagsType
  4. See TagTypeDef
  5. See StartTaskResponseTypeDef
Usage example with kwargs
kwargs: StartTaskRequestRequestTypeDef = {  # (1)
    "containerInstances": ...,
    "taskDefinition": ...,
}

parent.start_task(**kwargs)
  1. See StartTaskRequestRequestTypeDef

stop_task

Stops a running task.

Type annotations and code completion for boto3.client("ecs").stop_task method. boto3 documentation

Method definition
def stop_task(
    self,
    *,
    task: str,
    cluster: str = ...,
    reason: str = ...,
) -> StopTaskResponseTypeDef:  # (1)
    ...
  1. See StopTaskResponseTypeDef
Usage example with kwargs
kwargs: StopTaskRequestRequestTypeDef = {  # (1)
    "task": ...,
}

parent.stop_task(**kwargs)
  1. See StopTaskRequestRequestTypeDef

submit_attachment_state_changes

.

Type annotations and code completion for boto3.client("ecs").submit_attachment_state_changes method. boto3 documentation

Method definition
def submit_attachment_state_changes(
    self,
    *,
    attachments: Sequence[AttachmentStateChangeTypeDef],  # (1)
    cluster: str = ...,
) -> SubmitAttachmentStateChangesResponseTypeDef:  # (2)
    ...
  1. See AttachmentStateChangeTypeDef
  2. See SubmitAttachmentStateChangesResponseTypeDef
Usage example with kwargs
kwargs: SubmitAttachmentStateChangesRequestRequestTypeDef = {  # (1)
    "attachments": ...,
}

parent.submit_attachment_state_changes(**kwargs)
  1. See SubmitAttachmentStateChangesRequestRequestTypeDef

submit_container_state_change

.

Type annotations and code completion for boto3.client("ecs").submit_container_state_change method. boto3 documentation

Method definition
def submit_container_state_change(
    self,
    *,
    cluster: str = ...,
    task: str = ...,
    containerName: str = ...,
    runtimeId: str = ...,
    status: str = ...,
    exitCode: int = ...,
    reason: str = ...,
    networkBindings: Sequence[NetworkBindingTypeDef] = ...,  # (1)
) -> SubmitContainerStateChangeResponseTypeDef:  # (2)
    ...
  1. See NetworkBindingTypeDef
  2. See SubmitContainerStateChangeResponseTypeDef
Usage example with kwargs
kwargs: SubmitContainerStateChangeRequestRequestTypeDef = {  # (1)
    "cluster": ...,
}

parent.submit_container_state_change(**kwargs)
  1. See SubmitContainerStateChangeRequestRequestTypeDef

submit_task_state_change

.

Type annotations and code completion for boto3.client("ecs").submit_task_state_change method. boto3 documentation

Method definition
def submit_task_state_change(
    self,
    *,
    cluster: str = ...,
    task: str = ...,
    status: str = ...,
    reason: str = ...,
    containers: Sequence[ContainerStateChangeTypeDef] = ...,  # (1)
    attachments: Sequence[AttachmentStateChangeTypeDef] = ...,  # (2)
    managedAgents: Sequence[ManagedAgentStateChangeTypeDef] = ...,  # (3)
    pullStartedAt: Union[datetime, str] = ...,
    pullStoppedAt: Union[datetime, str] = ...,
    executionStoppedAt: Union[datetime, str] = ...,
) -> SubmitTaskStateChangeResponseTypeDef:  # (4)
    ...
  1. See ContainerStateChangeTypeDef
  2. See AttachmentStateChangeTypeDef
  3. See ManagedAgentStateChangeTypeDef
  4. See SubmitTaskStateChangeResponseTypeDef
Usage example with kwargs
kwargs: SubmitTaskStateChangeRequestRequestTypeDef = {  # (1)
    "cluster": ...,
}

parent.submit_task_state_change(**kwargs)
  1. See SubmitTaskStateChangeRequestRequestTypeDef

tag_resource

Associates the specified tags to a resource with the specified resourceArn.

Type annotations and code completion for boto3.client("ecs").tag_resource method. boto3 documentation

Method definition
def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See TagTypeDef
Usage example with kwargs
kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource

Deletes specified tags from a resource.

Type annotations and code completion for boto3.client("ecs").untag_resource method.