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

# ECSClient 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.

# Exceptions.exceptions usage example

client = boto3.client("ecs")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.AttributeLimitExceededException,
    client.exceptions.BlockedException,
    client.exceptions.ClientError,
    client.exceptions.ClientException,
    client.exceptions.ClusterContainsContainerInstancesException,
    client.exceptions.ClusterContainsServicesException,
    client.exceptions.ClusterContainsTasksException,
    client.exceptions.ClusterNotFoundException,
    client.exceptions.ConflictException,
    client.exceptions.InvalidParameterException,
    client.exceptions.LimitExceededException,
    client.exceptions.MissingVersionException,
    client.exceptions.NamespaceNotFoundException,
    client.exceptions.NoUpdateAvailableException,
    client.exceptions.PlatformTaskDefinitionIncompatibilityException,
    client.exceptions.PlatformUnknownException,
    client.exceptions.ResourceInUseException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServerException,
    client.exceptions.ServiceNotActiveException,
    client.exceptions.ServiceNotFoundException,
    client.exceptions.TargetNotConnectedException,
    client.exceptions.TargetNotFoundException,
    client.exceptions.TaskSetNotFoundException,
    client.exceptions.UnsupportedFeatureException,
    client.exceptions.UpdateInProgressException,
) as e:
    print(e)

# Exceptions.exceptions 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

# can_paginate 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

# close 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

# create_capacity_provider 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

# create_capacity_provider method usage example with argument unpacking

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

# create_cluster 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)
    serviceConnectDefaults: ClusterServiceConnectDefaultsRequestTypeDef = ...,  # (5)
) -> CreateClusterResponseTypeDef:  # (6)
    ...

1. See TagTypeDef
2. See ClusterSettingTypeDef
3. See ClusterConfigurationTypeDef
4. See CapacityProviderStrategyItemTypeDef
5. See ClusterServiceConnectDefaultsRequestTypeDef
6. See CreateClusterResponseTypeDef

# create_cluster method usage example with argument unpacking

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

# create_service method definition

def create_service(
    self,
    *,
    serviceName: str,
    cluster: str = ...,
    taskDefinition: str = ...,
    availabilityZoneRebalancing: AvailabilityZoneRebalancingType = ...,  # (1)
    loadBalancers: Sequence[LoadBalancerTypeDef] = ...,  # (2)
    serviceRegistries: Sequence[ServiceRegistryTypeDef] = ...,  # (3)
    desiredCount: int = ...,
    clientToken: str = ...,
    launchType: LaunchTypeType = ...,  # (4)
    capacityProviderStrategy: Sequence[CapacityProviderStrategyItemTypeDef] = ...,  # (5)
    platformVersion: str = ...,
    role: str = ...,
    deploymentConfiguration: DeploymentConfigurationTypeDef = ...,  # (6)
    placementConstraints: Sequence[PlacementConstraintTypeDef] = ...,  # (7)
    placementStrategy: Sequence[PlacementStrategyTypeDef] = ...,  # (8)
    networkConfiguration: NetworkConfigurationTypeDef = ...,  # (9)
    healthCheckGracePeriodSeconds: int = ...,
    schedulingStrategy: SchedulingStrategyType = ...,  # (10)
    deploymentController: DeploymentControllerTypeDef = ...,  # (11)
    tags: Sequence[TagTypeDef] = ...,  # (12)
    enableECSManagedTags: bool = ...,
    propagateTags: PropagateTagsType = ...,  # (13)
    enableExecuteCommand: bool = ...,
    serviceConnectConfiguration: ServiceConnectConfigurationTypeDef = ...,  # (14)
    volumeConfigurations: Sequence[ServiceVolumeConfigurationUnionTypeDef] = ...,  # (15)
    vpcLatticeConfigurations: Sequence[VpcLatticeConfigurationTypeDef] = ...,  # (16)
) -> CreateServiceResponseTypeDef:  # (17)
    ...

1. See AvailabilityZoneRebalancingType
2. See LoadBalancerTypeDef
3. See ServiceRegistryTypeDef
4. See LaunchTypeType
5. See CapacityProviderStrategyItemTypeDef
6. See DeploymentConfigurationTypeDef
7. See PlacementConstraintTypeDef
8. See PlacementStrategyTypeDef
9. See NetworkConfigurationTypeDef
10. See SchedulingStrategyType
11. See DeploymentControllerTypeDef
12. See TagTypeDef
13. See PropagateTagsType
14. See ServiceConnectConfigurationTypeDef
15. See ServiceVolumeConfigurationTypeDef ServiceVolumeConfigurationOutputTypeDef
16. See VpcLatticeConfigurationTypeDef
17. See CreateServiceResponseTypeDef

# create_service method usage example with argument unpacking

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

# create_task_set 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

# create_task_set method usage example with argument unpacking

kwargs: CreateTaskSetRequestRequestTypeDef = {  # (1)
    "service": ...,
    "cluster": ...,
    "taskDefinition": ...,
}

parent.create_task_set(**kwargs)

1. See CreateTaskSetRequestRequestTypeDef

delete_account_setting

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

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

# delete_account_setting method definition

def delete_account_setting(
    self,
    *,
    name: SettingNameType,  # (1)
    principalArn: str = ...,
) -> DeleteAccountSettingResponseTypeDef:  # (2)
    ...

1. See SettingNameType
2. See DeleteAccountSettingResponseTypeDef

# delete_account_setting method usage example with argument unpacking

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

# delete_attributes method definition

def delete_attributes(
    self,
    *,
    attributes: Sequence[AttributeTypeDef],  # (1)
    cluster: str = ...,
) -> DeleteAttributesResponseTypeDef:  # (2)
    ...

1. See AttributeTypeDef
2. See DeleteAttributesResponseTypeDef

# delete_attributes method usage example with argument unpacking

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

# delete_capacity_provider method definition

def delete_capacity_provider(
    self,
    *,
    capacityProvider: str,
) -> DeleteCapacityProviderResponseTypeDef:  # (1)
    ...

1. See DeleteCapacityProviderResponseTypeDef

# delete_capacity_provider method usage example with argument unpacking

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

# delete_cluster method definition

def delete_cluster(
    self,
    *,
    cluster: str,
) -> DeleteClusterResponseTypeDef:  # (1)
    ...

1. See DeleteClusterResponseTypeDef

# delete_cluster method usage example with argument unpacking

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

# delete_service method definition

def delete_service(
    self,
    *,
    service: str,
    cluster: str = ...,
    force: bool = ...,
) -> DeleteServiceResponseTypeDef:  # (1)
    ...

1. See DeleteServiceResponseTypeDef

# delete_service method usage example with argument unpacking

kwargs: DeleteServiceRequestRequestTypeDef = {  # (1)
    "service": ...,
}

parent.delete_service(**kwargs)

1. See DeleteServiceRequestRequestTypeDef

delete_task_definitions

Deletes one or more task definitions.

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

# delete_task_definitions method definition

def delete_task_definitions(
    self,
    *,
    taskDefinitions: Sequence[str],
) -> DeleteTaskDefinitionsResponseTypeDef:  # (1)
    ...

1. See DeleteTaskDefinitionsResponseTypeDef

# delete_task_definitions method usage example with argument unpacking

kwargs: DeleteTaskDefinitionsRequestRequestTypeDef = {  # (1)
    "taskDefinitions": ...,
}

parent.delete_task_definitions(**kwargs)

1. See DeleteTaskDefinitionsRequestRequestTypeDef

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

# delete_task_set method definition

def delete_task_set(
    self,
    *,
    cluster: str,
    service: str,
    taskSet: str,
    force: bool = ...,
) -> DeleteTaskSetResponseTypeDef:  # (1)
    ...

1. See DeleteTaskSetResponseTypeDef

# delete_task_set method usage example with argument unpacking

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

# deregister_container_instance method definition

def deregister_container_instance(
    self,
    *,
    containerInstance: str,
    cluster: str = ...,
    force: bool = ...,
) -> DeregisterContainerInstanceResponseTypeDef:  # (1)
    ...

1. See DeregisterContainerInstanceResponseTypeDef

# deregister_container_instance method usage example with argument unpacking

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

# deregister_task_definition method definition

def deregister_task_definition(
    self,
    *,
    taskDefinition: str,
) -> DeregisterTaskDefinitionResponseTypeDef:  # (1)
    ...

1. See DeregisterTaskDefinitionResponseTypeDef

# deregister_task_definition method usage example with argument unpacking

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

# describe_capacity_providers 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

# describe_capacity_providers method usage example with argument unpacking

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

# describe_clusters method definition

def describe_clusters(
    self,
    *,
    clusters: Sequence[str] = ...,
    include: Sequence[ClusterFieldType] = ...,  # (1)
) -> DescribeClustersResponseTypeDef:  # (2)
    ...

1. See ClusterFieldType
2. See DescribeClustersResponseTypeDef

# describe_clusters method usage example with argument unpacking

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

# describe_container_instances method definition

def describe_container_instances(
    self,
    *,
    containerInstances: Sequence[str],
    cluster: str = ...,
    include: Sequence[ContainerInstanceFieldType] = ...,  # (1)
) -> DescribeContainerInstancesResponseTypeDef:  # (2)
    ...

1. See ContainerInstanceFieldType
2. See DescribeContainerInstancesResponseTypeDef

# describe_container_instances method usage example with argument unpacking

kwargs: DescribeContainerInstancesRequestRequestTypeDef = {  # (1)
    "containerInstances": ...,
}

parent.describe_container_instances(**kwargs)

1. See DescribeContainerInstancesRequestRequestTypeDef

describe_service_deployments

Describes one or more of your service deployments.

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

# describe_service_deployments method definition

def describe_service_deployments(
    self,
    *,
    serviceDeploymentArns: Sequence[str],
) -> DescribeServiceDeploymentsResponseTypeDef:  # (1)
    ...

1. See DescribeServiceDeploymentsResponseTypeDef

# describe_service_deployments method usage example with argument unpacking

kwargs: DescribeServiceDeploymentsRequestRequestTypeDef = {  # (1)
    "serviceDeploymentArns": ...,
}

parent.describe_service_deployments(**kwargs)

1. See DescribeServiceDeploymentsRequestRequestTypeDef

describe_service_revisions

Describes one or more service revisions.

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

# describe_service_revisions method definition

def describe_service_revisions(
    self,
    *,
    serviceRevisionArns: Sequence[str],
) -> DescribeServiceRevisionsResponseTypeDef:  # (1)
    ...

1. See DescribeServiceRevisionsResponseTypeDef

# describe_service_revisions method usage example with argument unpacking

kwargs: DescribeServiceRevisionsRequestRequestTypeDef = {  # (1)
    "serviceRevisionArns": ...,
}

parent.describe_service_revisions(**kwargs)

1. See DescribeServiceRevisionsRequestRequestTypeDef

describe_services

Describes the specified services running in your cluster.

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

# describe_services method definition

def describe_services(
    self,
    *,
    services: Sequence[str],
    cluster: str = ...,
    include: Sequence[ServiceFieldType] = ...,  # (1)
) -> DescribeServicesResponseTypeDef:  # (2)
    ...

1. See ServiceFieldType
2. See DescribeServicesResponseTypeDef

# describe_services method usage example with argument unpacking

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

# describe_task_definition method definition

def describe_task_definition(
    self,
    *,
    taskDefinition: str,
    include: Sequence[TaskDefinitionFieldType] = ...,  # (1)
) -> DescribeTaskDefinitionResponseTypeDef:  # (2)
    ...

1. See TaskDefinitionFieldType
2. See DescribeTaskDefinitionResponseTypeDef

# describe_task_definition method usage example with argument unpacking

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

# describe_task_sets 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

# describe_task_sets method usage example with argument unpacking

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

# describe_tasks method definition

def describe_tasks(
    self,
    *,
    tasks: Sequence[str],
    cluster: str = ...,
    include: Sequence[TaskFieldType] = ...,  # (1)
) -> DescribeTasksResponseTypeDef:  # (2)
    ...

1. See TaskFieldType
2. See DescribeTasksResponseTypeDef

# describe_tasks method usage example with argument unpacking

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

# discover_poll_endpoint method definition

def discover_poll_endpoint(
    self,
    *,
    containerInstance: str = ...,
    cluster: str = ...,
) -> DiscoverPollEndpointResponseTypeDef:  # (1)
    ...

1. See DiscoverPollEndpointResponseTypeDef

# discover_poll_endpoint method usage example with argument unpacking

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

# execute_command method definition

def execute_command(
    self,
    *,
    command: str,
    interactive: bool,
    task: str,
    cluster: str = ...,
    container: str = ...,
) -> ExecuteCommandResponseTypeDef:  # (1)
    ...

1. See ExecuteCommandResponseTypeDef

# execute_command method usage example with argument unpacking

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

# generate_presigned_url method definition

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

get_task_protection

Retrieves the protection status of tasks in an Amazon ECS service.

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

# get_task_protection method definition

def get_task_protection(
    self,
    *,
    cluster: str,
    tasks: Sequence[str] = ...,
) -> GetTaskProtectionResponseTypeDef:  # (1)
    ...

1. See GetTaskProtectionResponseTypeDef

# get_task_protection method usage example with argument unpacking

kwargs: GetTaskProtectionRequestRequestTypeDef = {  # (1)
    "cluster": ...,
}

parent.get_task_protection(**kwargs)

1. See GetTaskProtectionRequestRequestTypeDef

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

# list_account_settings 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

# list_account_settings method usage example with argument unpacking

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

# list_attributes 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

# list_attributes method usage example with argument unpacking

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

# list_clusters method definition

def list_clusters(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListClustersResponseTypeDef:  # (1)
    ...

1. See ListClustersResponseTypeDef

# list_clusters method usage example with argument unpacking

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

# list_container_instances 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

# list_container_instances method usage example with argument unpacking

kwargs: ListContainerInstancesRequestRequestTypeDef = {  # (1)
    "cluster": ...,
}

parent.list_container_instances(**kwargs)

1. See ListContainerInstancesRequestRequestTypeDef

list_service_deployments

This operation lists all the service deployments that meet the specified filter criteria.

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

# list_service_deployments method definition

def list_service_deployments(
    self,
    *,
    service: str,
    cluster: str = ...,
    status: Sequence[ServiceDeploymentStatusType] = ...,  # (1)
    createdAt: CreatedAtTypeDef = ...,  # (2)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListServiceDeploymentsResponseTypeDef:  # (3)
    ...

1. See ServiceDeploymentStatusType
2. See CreatedAtTypeDef
3. See ListServiceDeploymentsResponseTypeDef

# list_service_deployments method usage example with argument unpacking

kwargs: ListServiceDeploymentsRequestRequestTypeDef = {  # (1)
    "service": ...,
}

parent.list_service_deployments(**kwargs)

1. See ListServiceDeploymentsRequestRequestTypeDef

list_services

Returns a list of services.

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

# list_services 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

# list_services method usage example with argument unpacking

kwargs: ListServicesRequestRequestTypeDef = {  # (1)
    "cluster": ...,
}

parent.list_services(**kwargs)

1. See ListServicesRequestRequestTypeDef

list_services_by_namespace

This operation lists all of the services that are associated with a Cloud Map namespace.

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

# list_services_by_namespace method definition

def list_services_by_namespace(
    self,
    *,
    namespace: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListServicesByNamespaceResponseTypeDef:  # (1)
    ...

1. See ListServicesByNamespaceResponseTypeDef

# list_services_by_namespace method usage example with argument unpacking

kwargs: ListServicesByNamespaceRequestRequestTypeDef = {  # (1)
    "namespace": ...,
}

parent.list_services_by_namespace(**kwargs)

1. See ListServicesByNamespaceRequestRequestTypeDef

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

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

# list_task_definition_families 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

# list_task_definition_families method usage example with argument unpacking

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

# list_task_definitions 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

# list_task_definitions method usage example with argument unpacking

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

# list_tasks 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

# list_tasks method usage example with argument unpacking

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

# put_account_setting method definition

def put_account_setting(
    self,
    *,
    name: SettingNameType,  # (1)
    value: str,
    principalArn: str = ...,
) -> PutAccountSettingResponseTypeDef:  # (2)
    ...

1. See SettingNameType
2. See PutAccountSettingResponseTypeDef

# put_account_setting method usage example with argument unpacking

kwargs: PutAccountSettingRequestRequestTypeDef = {  # (1)
    "name": ...,
    "value": ...,
}

parent.put_account_setting(**kwargs)

1. See PutAccountSettingRequestRequestTypeDef

put_account_setting_default

Modifies an account setting for all 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

# put_account_setting_default method definition

def put_account_setting_default(
    self,
    *,
    name: SettingNameType,  # (1)
    value: str,
) -> PutAccountSettingDefaultResponseTypeDef:  # (2)
    ...

1. See SettingNameType
2. See PutAccountSettingDefaultResponseTypeDef

# put_account_setting_default method usage example with argument unpacking

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

# put_attributes method definition

def put_attributes(
    self,
    *,
    attributes: Sequence[AttributeTypeDef],  # (1)
    cluster: str = ...,
) -> PutAttributesResponseTypeDef:  # (2)
    ...

1. See AttributeTypeDef
2. See PutAttributesResponseTypeDef

# put_attributes method usage example with argument unpacking

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

# put_cluster_capacity_providers 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

# put_cluster_capacity_providers method usage example with argument unpacking

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

# register_container_instance method definition

def register_container_instance(
    self,
    *,
    cluster: str = ...,
    instanceIdentityDocument: str = ...,
    instanceIdentityDocumentSignature: str = ...,
    totalResources: Sequence[ResourceUnionTypeDef] = ...,  # (1)
    versionInfo: VersionInfoTypeDef = ...,  # (2)
    containerInstanceArn: str = ...,
    attributes: Sequence[AttributeTypeDef] = ...,  # (3)
    platformDevices: Sequence[PlatformDeviceTypeDef] = ...,  # (4)
    tags: Sequence[TagTypeDef] = ...,  # (5)
) -> RegisterContainerInstanceResponseTypeDef:  # (6)
    ...

1. See ResourceTypeDef ResourceOutputTypeDef
2. See VersionInfoTypeDef
3. See AttributeTypeDef
4. See PlatformDeviceTypeDef
5. See TagTypeDef
6. See RegisterContainerInstanceResponseTypeDef

# register_container_instance method usage example with argument unpacking

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

# register_task_definition method definition

def register_task_definition(
    self,
    *,
    family: str,
    containerDefinitions: Sequence[ContainerDefinitionUnionTypeDef],  # (1)
    taskRoleArn: str = ...,
    executionRoleArn: str = ...,
    networkMode: NetworkModeType = ...,  # (2)
    volumes: Sequence[VolumeUnionTypeDef] = ...,  # (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 ContainerDefinitionOutputTypeDef
2. See NetworkModeType
3. See VolumeTypeDef VolumeOutputTypeDef
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

# register_task_definition method usage example with argument unpacking

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

# run_task 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)
    clientToken: str = ...,
    volumeConfigurations: Sequence[TaskVolumeConfigurationTypeDef] = ...,  # (9)
) -> RunTaskResponseTypeDef:  # (10)
    ...

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 TaskVolumeConfigurationTypeDef
10. See RunTaskResponseTypeDef

# run_task method usage example with argument unpacking

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

# start_task 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)
    volumeConfigurations: Sequence[TaskVolumeConfigurationTypeDef] = ...,  # (5)
) -> StartTaskResponseTypeDef:  # (6)
    ...

1. See NetworkConfigurationTypeDef
2. See TaskOverrideTypeDef
3. See PropagateTagsType
4. See TagTypeDef
5. See TaskVolumeConfigurationTypeDef
6. See StartTaskResponseTypeDef

# start_task method usage example with argument unpacking

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

# stop_task method definition

def stop_task(
    self,
    *,
    task: str,
    cluster: str = ...,
    reason: str = ...,
) -> StopTaskResponseTypeDef:  # (1)
    ...

1. See StopTaskResponseTypeDef

# stop_task method usage example with argument unpacking

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

# submit_attachment_state_changes method definition

def submit_attachment_state_changes(
    self,
    *,
    attachments: Sequence[AttachmentStateChangeTypeDef],  # (1)
    cluster: str = ...,
) -> SubmitAttachmentStateChangesResponseTypeDef:  # (2)
    ...

1. See AttachmentStateChangeTypeDef
2. See SubmitAttachmentStateChangesResponseTypeDef

# submit_attachment_state_changes method usage example with argument unpacking

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

# submit_container_state_change 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

# submit_container_state_change method usage example with argument unpacking

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

# submit_task_state_change 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: TimestampTypeDef = ...,
    pullStoppedAt: TimestampTypeDef = ...,
    executionStoppedAt: TimestampTypeDef = ...,
) -> SubmitTaskStateChangeResponseTypeDef:  # (4)
    ...

1. See ContainerStateChangeTypeDef
2. See AttachmentStateChangeTypeDef
3. See ManagedAgentStateChangeTypeDef
4. See SubmitTaskStateChangeResponseTypeDef

# submit_task_state_change method usage example with argument unpacking

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See TagTypeDef

# tag_resource method usage example with argument unpacking

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. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_capacity_provider

Modifies the parameters for a capacity provider.

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

# update_capacity_provider method definition

def update_capacity_provider(
    self,
    *,
    name: str,
    autoScalingGroupProvider: AutoScalingGroupProviderUpdateTypeDef,  # (1)
) -> UpdateCapacityProviderResponseTypeDef:  # (2)
    ...

1. See AutoScalingGroupProviderUpdateTypeDef
2. See UpdateCapacityProviderResponseTypeDef

# update_capacity_provider method usage example with argument unpacking

kwargs: UpdateCapacityProviderRequestRequestTypeDef = {  # (1)
    "name": ...,
    "autoScalingGroupProvider": ...,
}

parent.update_capacity_provider(**kwargs)

1. See UpdateCapacityProviderRequestRequestTypeDef

update_cluster

Updates the cluster.

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

# update_cluster method definition

def update_cluster(
    self,
    *,
    cluster: str,
    settings: Sequence[ClusterSettingTypeDef] = ...,  # (1)
    configuration: ClusterConfigurationTypeDef = ...,  # (2)
    serviceConnectDefaults: ClusterServiceConnectDefaultsRequestTypeDef = ...,  # (3)
) -> UpdateClusterResponseTypeDef:  # (4)
    ...

1. See ClusterSettingTypeDef
2. See ClusterConfigurationTypeDef
3. See ClusterServiceConnectDefaultsRequestTypeDef
4. See UpdateClusterResponseTypeDef

# update_cluster method usage example with argument unpacking

kwargs: UpdateClusterRequestRequestTypeDef = {  # (1)
    "cluster": ...,
}

parent.update_cluster(**kwargs)

1. See UpdateClusterRequestRequestTypeDef

update_cluster_settings

Modifies the settings to use for a cluster.

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

# update_cluster_settings method definition

def update_cluster_settings(
    self,
    *,
    cluster: str,
    settings: Sequence[ClusterSettingTypeDef],  # (1)
) -> UpdateClusterSettingsResponseTypeDef:  # (2)
    ...

1. See ClusterSettingTypeDef
2. See UpdateClusterSettingsResponseTypeDef

# update_cluster_settings method usage example with argument unpacking

kwargs: UpdateClusterSettingsRequestRequestTypeDef = {  # (1)
    "cluster": ...,
    "settings": ...,
}

parent.update_cluster_settings(**kwargs)

1. See UpdateClusterSettingsRequestRequestTypeDef

update_container_agent

Updates the Amazon ECS container agent on a specified container instance.

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

# update_container_agent method definition

def update_container_agent(
    self,
    *,
    containerInstance: str,
    cluster: str = ...,
) -> UpdateContainerAgentResponseTypeDef:  # (1)
    ...

1. See UpdateContainerAgentResponseTypeDef

# update_container_agent method usage example with argument unpacking

kwargs: UpdateContainerAgentRequestRequestTypeDef = {  # (1)
    "containerInstance": ...,
}

parent.update_container_agent(**kwargs)

1. See UpdateContainerAgentRequestRequestTypeDef

update_container_instances_state

Modifies the status of an Amazon ECS container instance.

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

# update_container_instances_state method definition

def update_container_instances_state(
    self,
    *,
    containerInstances: Sequence[str],
    status: ContainerInstanceStatusType,  # (1)
    cluster: str = ...,
) -> UpdateContainerInstancesStateResponseTypeDef:  # (2)
    ...

1. See ContainerInstanceStatusType
2. See UpdateContainerInstancesStateResponseTypeDef

# update_container_instances_state method usage example with argument unpacking

kwargs: UpdateContainerInstancesStateRequestRequestTypeDef = {  # (1)
    "containerInstances": ...,
    "status": ...,
}

parent.update_container_instances_state(**kwargs)

1. See UpdateContainerInstancesStateRequestRequestTypeDef

update_service

Modifies the parameters of a service.

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

# update_service method definition

def update_service(
    self,
    *,
    service: str,
    cluster: str = ...,
    desiredCount: int = ...,
    taskDefinition: str = ...,
    capacityProviderStrategy: Sequence[CapacityProviderStrategyItemTypeDef] = ...,  # (1)
    deploymentConfiguration: DeploymentConfigurationTypeDef = ...,  # (2)
    availabilityZoneRebalancing: AvailabilityZoneRebalancingType = ...,  # (3)
    networkConfiguration: NetworkConfigurationTypeDef = ...,  # (4)
    placementConstraints: Sequence[PlacementConstraintTypeDef] = ...,  # (5)
    placementStrategy: Sequence[PlacementStrategyTypeDef] = ...,  # (6)
    platformVersion: str = ...,
    forceNewDeployment: bool = ...,
    healthCheckGracePeriodSeconds: int = ...,
    enableExecuteCommand: bool = ...,
    enableECSManagedTags: bool = ...,
    loadBalancers: Sequence[LoadBalancerTypeDef] = ...,  # (7)
    propagateTags: PropagateTagsType = ...,  # (8)
    serviceRegistries: Sequence[ServiceRegistryTypeDef] = ...,  # (9)
    serviceConnectConfiguration: ServiceConnectConfigurationTypeDef = ...,  # (10)
    volumeConfigurations: Sequence[ServiceVolumeConfigurationTypeDef] = ...,  # (11)
    vpcLatticeConfigurations: Sequence[VpcLatticeConfigurationTypeDef] = ...,  # (12)
) -> UpdateServiceResponseTypeDef:  # (13)
    ...

1. See CapacityProviderStrategyItemTypeDef
2. See DeploymentConfigurationTypeDef
3. See AvailabilityZoneRebalancingType
4. See NetworkConfigurationTypeDef
5. See PlacementConstraintTypeDef
6. See PlacementStrategyTypeDef
7. See LoadBalancerTypeDef
8. See PropagateTagsType
9. See ServiceRegistryTypeDef
10. See ServiceConnectConfigurationTypeDef
11. See ServiceVolumeConfigurationTypeDef
12. See VpcLatticeConfigurationTypeDef
13. See UpdateServiceResponseTypeDef

# update_service method usage example with argument unpacking

kwargs: UpdateServiceRequestRequestTypeDef = {  # (1)
    "service": ...,
}

parent.update_service(**kwargs)

1. See UpdateServiceRequestRequestTypeDef

update_service_primary_task_set

Modifies which task set in a service is the primary task set.

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

# update_service_primary_task_set method definition

def update_service_primary_task_set(
    self,
    *,
    cluster: str,
    service: str,
    primaryTaskSet: str,
) -> UpdateServicePrimaryTaskSetResponseTypeDef:  # (1)
    ...

1. See UpdateServicePrimaryTaskSetResponseTypeDef

# update_service_primary_task_set method usage example with argument unpacking

kwargs: UpdateServicePrimaryTaskSetRequestRequestTypeDef = {  # (1)
    "cluster": ...,
    "service": ...,
    "primaryTaskSet": ...,
}

parent.update_service_primary_task_set(**kwargs)

1. See UpdateServicePrimaryTaskSetRequestRequestTypeDef

update_task_protection

Updates the protection status of a task.

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

# update_task_protection method definition

def update_task_protection(
    self,
    *,
    cluster: str,
    tasks: Sequence[str],
    protectionEnabled: bool,
    expiresInMinutes: int = ...,
) -> UpdateTaskProtectionResponseTypeDef:  # (1)
    ...

1. See UpdateTaskProtectionResponseTypeDef

# update_task_protection method usage example with argument unpacking

kwargs: UpdateTaskProtectionRequestRequestTypeDef = {  # (1)
    "cluster": ...,
    "tasks": ...,
    "protectionEnabled": ...,
}

parent.update_task_protection(**kwargs)

1. See UpdateTaskProtectionRequestRequestTypeDef

update_task_set

Modifies a task set.

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

# update_task_set method definition

def update_task_set(
    self,
    *,
    cluster: str,
    service: str,
    taskSet: str,
    scale: ScaleTypeDef,  # (1)
) -> UpdateTaskSetResponseTypeDef:  # (2)
    ...

1. See ScaleTypeDef
2. See UpdateTaskSetResponseTypeDef

# update_task_set method usage example with argument unpacking

kwargs: UpdateTaskSetRequestRequestTypeDef = {  # (1)
    "cluster": ...,
    "service": ...,
    "taskSet": ...,
    "scale": ...,
}

parent.update_task_set(**kwargs)

1. See UpdateTaskSetRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("ecs").get_paginator method with overloads.

• client.get_paginator("list_account_settings") -> ListAccountSettingsPaginator
• client.get_paginator("list_attributes") -> ListAttributesPaginator
• client.get_paginator("list_clusters") -> ListClustersPaginator
• client.get_paginator("list_container_instances") -> ListContainerInstancesPaginator
• client.get_paginator("list_services_by_namespace") -> ListServicesByNamespacePaginator
• client.get_paginator("list_services") -> ListServicesPaginator
• client.get_paginator("list_task_definition_families") -> ListTaskDefinitionFamiliesPaginator
• client.get_paginator("list_task_definitions") -> ListTaskDefinitionsPaginator
• client.get_paginator("list_tasks") -> ListTasksPaginator

get_waiter

Type annotations and code completion for boto3.client("ecs").get_waiter method with overloads.

• client.get_waiter("services_inactive") -> ServicesInactiveWaiter
• client.get_waiter("services_stable") -> ServicesStableWaiter
• client.get_waiter("tasks_running") -> TasksRunningWaiter
• client.get_waiter("tasks_stopped") -> TasksStoppedWaiter