delete_capacity_provider¶
Operation¶
async
¶
delete_capacity_provider(input: DeleteCapacityProviderInput, plugins: list[Plugin] | None = None) -> 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 |
|---|---|---|---|
input
|
DeleteCapacityProviderInput
|
An instance of |
required |
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
|
Returns:
| Type | Description |
|---|---|
DeleteCapacityProviderOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for DeleteCapacityProviderInput structure.
Attributes¶
class-attribute
instance-attribute
¶
capacity_provider_id: str | None = None
The unique identifier of the capacity provider to delete.
class-attribute
instance-attribute
¶
client_token: str | None = 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.
Output¶
dataclass
¶
Dataclass for DeleteCapacityProviderOutput structure.
Attributes¶
instance-attribute
¶
capacity_provider_id: str
The unique identifier of the deleted capacity provider.
instance-attribute
¶
status: CapacityProviderStatus
The current status of the capacity provider. For possible values, see
CapacityProviderStatus.