Skip to content

update_service_primary_task_set

Operation

update_service_primary_task_set

update_service_primary_task_set(request: UpdateServicePrimaryTaskSetInput | UpdateServicePrimaryTaskSetInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateServicePrimaryTaskSetInputDict]) -> UpdateServicePrimaryTaskSetOutput

Modifies which task set in a service is the primary task set. Any parameters that are updated on the primary task set in a service will transition to the service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.

Parameters:

Name Type Description Default
request UpdateServicePrimaryTaskSetInput | UpdateServicePrimaryTaskSetInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[UpdateServicePrimaryTaskSetInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateServicePrimaryTaskSetOutput

An instance of UpdateServicePrimaryTaskSetOutput.

update_service_primary_task_set async

update_service_primary_task_set(request: UpdateServicePrimaryTaskSetInput | UpdateServicePrimaryTaskSetInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateServicePrimaryTaskSetInputDict]) -> UpdateServicePrimaryTaskSetOutput

Modifies which task set in a service is the primary task set. Any parameters that are updated on the primary task set in a service will transition to the service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.

Parameters:

Name Type Description Default
request UpdateServicePrimaryTaskSetInput | UpdateServicePrimaryTaskSetInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[UpdateServicePrimaryTaskSetInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateServicePrimaryTaskSetOutput

An instance of UpdateServicePrimaryTaskSetOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

UpdateServicePrimaryTaskSetInputDict

Bases: TypedDict

Dictionary form of UpdateServicePrimaryTaskSetInput.

Attributes

cluster instance-attribute
cluster: Required[str]

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists in.

primary_task_set instance-attribute
primary_task_set: Required[str]

The short name or full Amazon Resource Name (ARN) of the task set to set as the primary task set in the deployment.

service instance-attribute
service: Required[str]

The short name or full Amazon Resource Name (ARN) of the service that the task set exists in.

UpdateServicePrimaryTaskSetInput dataclass

Bases: _SerdeShape

Dataclass for UpdateServicePrimaryTaskSetInput structure.

Attributes

cluster class-attribute instance-attribute
cluster: str | None = ...

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists in.

primary_task_set class-attribute instance-attribute
primary_task_set: str | None = ...

The short name or full Amazon Resource Name (ARN) of the task set to set as the primary task set in the deployment.

service class-attribute instance-attribute
service: str | None = ...

The short name or full Amazon Resource Name (ARN) of the service that the task set exists in.

Output

UpdateServicePrimaryTaskSetOutput dataclass

Bases: _SerdeShape

Dataclass for UpdateServicePrimaryTaskSetOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

task_set class-attribute instance-attribute
task_set: TaskSet | None = ...

The details about the task set.