Skip to content

describe_service_deployments

Operation

describe_service_deployments

describe_service_deployments(request: DescribeServiceDeploymentsInput | DescribeServiceDeploymentsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeServiceDeploymentsInputDict]) -> DescribeServiceDeploymentsOutput

Describes one or more of your service deployments.

A service deployment happens when you release a software update for the service. For more information, see View service history using Amazon ECS service deployments.

Parameters:

Name Type Description Default
request DescribeServiceDeploymentsInput | DescribeServiceDeploymentsInputDict | 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[DescribeServiceDeploymentsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeServiceDeploymentsOutput

An instance of DescribeServiceDeploymentsOutput.

describe_service_deployments async

describe_service_deployments(request: DescribeServiceDeploymentsInput | DescribeServiceDeploymentsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeServiceDeploymentsInputDict]) -> DescribeServiceDeploymentsOutput

Describes one or more of your service deployments.

A service deployment happens when you release a software update for the service. For more information, see View service history using Amazon ECS service deployments.

Parameters:

Name Type Description Default
request DescribeServiceDeploymentsInput | DescribeServiceDeploymentsInputDict | 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[DescribeServiceDeploymentsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeServiceDeploymentsOutput

An instance of DescribeServiceDeploymentsOutput.

Input

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

DescribeServiceDeploymentsInputDict

Bases: TypedDict

Dictionary form of DescribeServiceDeploymentsInput.

Attributes

service_deployment_arns instance-attribute
service_deployment_arns: Required[Sequence[str]]

The ARN of the service deployment.

You can specify a maximum of 20 ARNs.

DescribeServiceDeploymentsInput dataclass

Bases: _SerdeShape

Dataclass for DescribeServiceDeploymentsInput structure.

Attributes

service_deployment_arns class-attribute instance-attribute
service_deployment_arns: list[str] | None = ...

The ARN of the service deployment.

You can specify a maximum of 20 ARNs.

Output

DescribeServiceDeploymentsOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeServiceDeploymentsOutput structure.

Attributes

failures class-attribute instance-attribute
failures: list[Failure] | None = ...

Any failures associated with the call.

If you decsribe a deployment with a service revision created before October 25, 2024, the call fails. The failure includes the service revision ARN and the reason set to MISSING.

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.

service_deployments class-attribute instance-attribute
service_deployments: list[ServiceDeployment] | None = ...

The list of service deployments described.