Cancels a flat-rate pricing subscription.
For active subscriptions, the cancellation is scheduled to take effect at the end of the current billing period. The subscription remains active until that date. To revert a pending cancellation, use CancelSubscriptionChange.
For subscriptions in PENDING_APPROVAL status, the subscription is deleted immediately without scheduling.
Parameters:
-
arn
(SubscriptionArn)
–
The ARN of the subscription to cancel.
-
if_match
(str)
–
The ETag value from a previous GetSubscription or ListSubscriptions response.
-
client_token
(Optional[IdempotencyToken], default:
None
)
–
A unique, case-sensitive identifier that you provide to ensure the request is handled only once.
Raises:
-
AccessDeniedException
–
You do not have the required permissions to perform this operation. Verify that your IAM policy grants access to this action.
-
ConflictException
–
The request conflicts with the current state of the resource. This typically occurs when the ETag value in the If-Match header does not match the current version of the subscription. Retrieve the latest version and retry.
-
InternalServerException
–
An unexpected error occurred on the server. Retry the request.
-
ResourceNotFoundException
–
The specified subscription was not found. Verify that the ARN is correct and that the subscription belongs to your account.
-
ThrottlingException
–
The request rate exceeds the allowed limit. Wait briefly and retry the request.
-
ValidationException
–
The request failed a business rule validation. For example, the specified resource might already be associated with another subscription, or the subscription might not be in the required state for this operation.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Examples:
Cancel a subscription
>>> client.cancel_subscription(arn='arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890', if_match='2')
Source code in docs_src/capo_pricing_plan_manager/_services/pricing_plan_manager.py
| def cancel_subscription(
self,
arn: "capo_pricing_plan_manager.types.subscription_arn.SubscriptionArn",
if_match: str,
*,
config_overrides: Optional[PricingPlanManagerClientConfig] = None,
client_token: Optional[
"capo_pricing_plan_manager.types.idempotency_token.IdempotencyToken"
] = None,
) -> "capo_pricing_plan_manager.types.cancel_subscription_output.CancelSubscriptionOutput":
"""<p>Cancels a flat-rate pricing subscription.</p> <note> <p>For active subscriptions, the cancellation is scheduled to take effect at the end of the current billing period. The subscription remains active until that date. To revert a pending cancellation, use <code>CancelSubscriptionChange</code>.</p> <p>For subscriptions in <code>PENDING_APPROVAL</code> status, the subscription is deleted immediately without scheduling.</p> </note>
Args:
arn: <p>The ARN of the subscription to cancel.</p>
if_match: <p>The <code>ETag</code> value from a previous <code>GetSubscription</code> or <code>ListSubscriptions</code> response.</p>
client_token: <p>A unique, case-sensitive identifier that you provide to ensure the request is handled only once.</p>
Raises:
capo_pricing_plan_manager.errors.access_denied_exception.AccessDeniedException: <p>You do not have the required permissions to perform this operation. Verify that your IAM policy grants access to this action.</p>
capo_pricing_plan_manager.errors.conflict_exception.ConflictException: <p>The request conflicts with the current state of the resource. This typically occurs when the <code>ETag</code> value in the <code>If-Match</code> header does not match the current version of the subscription. Retrieve the latest version and retry.</p>
capo_pricing_plan_manager.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred on the server. Retry the request.</p>
capo_pricing_plan_manager.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified subscription was not found. Verify that the ARN is correct and that the subscription belongs to your account.</p>
capo_pricing_plan_manager.errors.throttling_exception.ThrottlingException: <p>The request rate exceeds the allowed limit. Wait briefly and retry the request.</p>
capo_pricing_plan_manager.errors.validation_exception.ValidationException: <p>The request failed a business rule validation. For example, the specified resource might already be associated with another subscription, or the subscription might not be in the required state for this operation.</p>
capo_pricing_plan_manager.errors.UnknownServiceError: The service returned an error code this client does not model.
Examples:
Cancel a subscription
>>> client.cancel_subscription(arn='arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890', if_match='2')
"""
def _handler(
req: "OperationRequest[capo_pricing_plan_manager.types.cancel_subscription_input.CancelSubscriptionInput]",
) -> OperationResponse[
"capo_pricing_plan_manager.types.cancel_subscription_output.CancelSubscriptionOutput"
]:
import capo_pricing_plan_manager._operations.aws_pricing_plan_manager.cancel_subscription
output, http_response = (
capo_pricing_plan_manager._operations.aws_pricing_plan_manager.cancel_subscription.cancel_subscription(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("CancelSubscription")
)
input_: capo_pricing_plan_manager.types.cancel_subscription_input.CancelSubscriptionInput = {
"arn": arn,
"if_match": if_match,
}
if client_token is None:
client_token = str(uuid.uuid4())
input_["client_token"] = client_token
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|