Skip to content

delete_capacity_provider

Operation

delete_capacity_provider

delete_capacity_provider(request: DeleteCapacityProviderInput | DeleteCapacityProviderInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteCapacityProviderInputDict]) -> DeleteCapacityProviderOutput

Deletes a capacity provider. Before you delete a capacity provider, disassociate all agent runtimes and runtime versions that reference it. If any references remain, the operation fails.

Parameters:

Name Type Description Default
request DeleteCapacityProviderInput | DeleteCapacityProviderInputDict | 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[DeleteCapacityProviderInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteCapacityProviderOutput

An instance of DeleteCapacityProviderOutput.

delete_capacity_provider async

delete_capacity_provider(request: DeleteCapacityProviderInput | DeleteCapacityProviderInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteCapacityProviderInputDict]) -> DeleteCapacityProviderOutput

Deletes a capacity provider. Before you delete a capacity provider, disassociate all agent runtimes and runtime versions that reference it. If any references remain, the operation fails.

Parameters:

Name Type Description Default
request DeleteCapacityProviderInput | DeleteCapacityProviderInputDict | 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[DeleteCapacityProviderInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteCapacityProviderOutput

An instance of DeleteCapacityProviderOutput.

Input

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

DeleteCapacityProviderInputDict

Bases: TypedDict

Dictionary form of DeleteCapacityProviderInput.

Attributes

capacity_provider_id instance-attribute
capacity_provider_id: Required[str]

The unique identifier of the capacity provider to delete.

client_token instance-attribute
client_token: str | None

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

This field is autopopulated if not provided.

DeleteCapacityProviderInput dataclass

Bases: _SerdeShape

Dataclass for DeleteCapacityProviderInput structure.

Attributes

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

The unique identifier of the capacity provider to delete.

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

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

This field is autopopulated if not provided.

Output

DeleteCapacityProviderOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteCapacityProviderOutput structure.

Attributes

capacity_provider_id instance-attribute
capacity_provider_id: str

The unique identifier of the deleted capacity provider.

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.

status instance-attribute
status: str

The current status of the capacity provider. For possible values, see CapacityProviderStatus.