View Source AWS.PricingPlanManager (aws-elixir v1.0.15)

Manages flat-rate pricing subscriptions for supported AWS services.

Use this API to create, approve, update, and cancel subscriptions; associate and disassociate resources; and retrieve subscription details. With a flat-rate pricing subscription, you pay a fixed recurring fee for eligible resources instead of usage-based pricing.

Link to this section Summary

Functions

Approves a subscription that is in PENDING_APPROVAL status, activating it and starting billing.

Adds one or more resources to an existing subscription.

Cancels a flat-rate pricing subscription.

Cancels a pending scheduled change on a subscription, such as a pending downgrade or cancellation.

Creates a flat-rate pricing subscription for the specified resources.

Removes one or more resources from an existing subscription.

Returns the details of a flat-rate pricing subscription, including its current status, associated resources, and any pending scheduled changes.

Returns a summary of all flat-rate pricing subscriptions in the calling account.

Changes the plan tier of an existing subscription.

Link to this section Functions

Link to this function

approve_paid_subscription(client, input, options \\ [])

View Source

Approves a subscription that is in PENDING_APPROVAL status, activating it and starting billing.

This operation requires the current ETag value for concurrency control. Retrieve it from a previous GetSubscription or ListSubscriptions response.

Link to this function

associate_resources_to_subscription(client, input, options \\ [])

View Source

Adds one or more resources to an existing subscription.

The subscription must be in an active state that is not pending other changes.

For subscriptions in the CloudFront plan family, the associated resources must include exactly one Amazon CloudFront distribution and one AWS WAF web ACL. You can also include other supported resources, such as Amazon Route 53 hosted zones, and CloudFront KeyValueStores.

Link to this function

cancel_subscription(client, input, options \\ [])

View Source

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.

Link to this function

cancel_subscription_change(client, input, options \\ [])

View Source

Cancels a pending scheduled change on a subscription, such as a pending downgrade or cancellation.

The subscription returns to its state before the change was scheduled.

You cannot cancel a scheduled change close to its effective date. If the change is within the processing window, this operation returns an error.

Link to this function

create_subscription(client, input, options \\ [])

View Source

Creates a flat-rate pricing subscription for the specified resources.

When approvalMode is set to MANUAL, paid-tier subscriptions are created in PENDING_APPROVAL status and require a separate ApprovePaidSubscription call before billing starts. Free-tier subscriptions are always activated immediately regardless of approval mode.

When approvalMode is set to IMMEDIATE or is not specified, the subscription is activated immediately.

Link to this function

disassociate_resources_from_subscription(client, input, options \\ [])

View Source

Removes one or more resources from an existing subscription.

For subscriptions in the CloudFront plan family, the associated resources must always include exactly one Amazon CloudFront distribution and exactly one AWS WAF web ACL. You cannot remove these required resources.

Link to this function

get_subscription(client, input, options \\ [])

View Source

Returns the details of a flat-rate pricing subscription, including its current status, associated resources, and any pending scheduled changes.

Link to this function

list_subscriptions(client, input, options \\ [])

View Source

Returns a summary of all flat-rate pricing subscriptions in the calling account.

Link to this function

update_subscription(client, input, options \\ [])

View Source

Changes the plan tier of an existing subscription.

Upgrades take effect immediately. Downgrades are scheduled and the current tier remains unchanged until the end of the billing cycle (calendar month). You cannot update a subscription while a scheduled change is pending. To make a new change, first cancel the pending change using CancelSubscriptionChange.

This operation replaces the plan tier value. If you omit the optional usageLevel field, it is reset to the default.