Skip to content

delete_secondary_subnet async

delete_secondary_subnet(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    client_token: Optional[String] = None,
    dry_run: Optional[Boolean] = None,
    secondary_subnet_id: Optional[SecondarySubnetId] = None,
) -> DeleteSecondarySubnetResult

Deletes a secondary subnet. A secondary subnet must not contain any secondary interfaces prior to deletion.

Parameters:

  • client_token (Optional[String], default: None ) –

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

  • dry_run (Optional[Boolean], default: None ) –

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

  • secondary_subnet_id (Optional[SecondarySubnetId], default: None ) –

    The ID of the secondary subnet to delete.

Raises:

Examples:

To delete a secondary subnet This example deletes a secondary subnet.

>>> await client.delete_secondary_subnet(secondary_subnet_id='ss-0123456789abcdef0', client_token='550e8400-e29b-41d4-a716-446655440000')
Source code in docs_src/capo_ec2/_services/async_ec2.py
async def delete_secondary_subnet(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    client_token: Optional["capo_ec2.types.string.String"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    secondary_subnet_id: Optional[
        "capo_ec2.types.secondary_subnet_id.SecondarySubnetId"
    ] = None,
) -> "capo_ec2.types.delete_secondary_subnet_result.DeleteSecondarySubnetResult":
    """<p>Deletes a secondary subnet. A secondary subnet must not contain any secondary interfaces prior to deletion.</p>

    Args:
        client_token: <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html">Ensure Idempotency</a>.</p>
        dry_run: <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
        secondary_subnet_id: <p>The ID of the secondary subnet to delete.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To delete a secondary subnet
        This example deletes a secondary subnet.

        >>> await client.delete_secondary_subnet(secondary_subnet_id='ss-0123456789abcdef0', client_token='550e8400-e29b-41d4-a716-446655440000')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ec2.types.delete_secondary_subnet_request.DeleteSecondarySubnetRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.delete_secondary_subnet_result.DeleteSecondarySubnetResult"
    ]:
        import capo_ec2._operations.amazon_ec2.delete_secondary_subnet

        (
            output,
            http_response,
        ) = await capo_ec2._operations.amazon_ec2.delete_secondary_subnet.async_delete_secondary_subnet(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteSecondarySubnet")
    )
    input_: capo_ec2.types.delete_secondary_subnet_request.DeleteSecondarySubnetRequest = {}
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if secondary_subnet_id is not None:
        input_["secondary_subnet_id"] = secondary_subnet_id

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output