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.
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.
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.
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.
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.
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.
Returns the details of a flat-rate pricing subscription, including its current status, associated resources, and any pending scheduled changes.
", "readonly":true }, "ListSubscriptions":{ "name":"ListSubscriptions", "http":{ "method":"POST", "requestUri":"/v1/ListSubscriptions", "responseCode":200 }, "input":{"shape":"ListSubscriptionsInput"}, "output":{"shape":"ListSubscriptionsOutput"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Returns a summary of all flat-rate pricing subscriptions in the calling account.
", "readonly":true }, "UpdateSubscription":{ "name":"UpdateSubscription", "http":{ "method":"POST", "requestUri":"/v1/UpdateSubscription", "responseCode":200 }, "input":{"shape":"UpdateSubscriptionInput"}, "output":{"shape":"UpdateSubscriptionOutput"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"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.
You do not have the required permissions to perform this operation. Verify that your IAM policy grants access to this action.
", "error":{ "httpStatusCode":403, "senderFault":true }, "exception":true }, "ApprovalMode":{ "type":"string", "documentation":"Determines whether a subscription requires explicit approval before billing starts.
", "enum":[ "MANUAL", "IMMEDIATE" ] }, "ApprovePaidSubscriptionInput":{ "type":"structure", "required":[ "arn", "ifMatch" ], "members":{ "arn":{ "shape":"SubscriptionArn", "documentation":"The ARN of the subscription to approve.
" }, "ifMatch":{ "shape":"String", "documentation":"The ETag value from a previous GetSubscription or ListSubscriptions response. This ensures you are approving the expected version of the subscription.
A unique, case-sensitive identifier that you provide to ensure the request is handled only once.
", "idempotencyToken":true } } }, "ApprovePaidSubscriptionOutput":{ "type":"structure", "required":[ "subscription", "eTag" ], "members":{ "subscription":{ "shape":"Subscription", "documentation":"The details of the approved subscription.
" }, "eTag":{ "shape":"String", "documentation":"The updated entity tag for concurrency control.
", "location":"header", "locationName":"ETag" } }, "payload":"subscription" }, "AssociateResourcesToSubscriptionInput":{ "type":"structure", "required":[ "arn", "resourceArns", "ifMatch" ], "members":{ "arn":{ "shape":"SubscriptionArn", "documentation":"The ARN of the subscription to add resources to.
" }, "resourceArns":{ "shape":"ResourceArns", "documentation":"The ARNs of the resources to add to the subscription.
" }, "ifMatch":{ "shape":"String", "documentation":"The ETag value from a previous GetSubscription or ListSubscriptions response.
A unique, case-sensitive identifier that you provide to ensure the request is handled only once.
", "idempotencyToken":true } } }, "AssociateResourcesToSubscriptionOutput":{ "type":"structure", "required":[ "subscription", "eTag" ], "members":{ "subscription":{ "shape":"Subscription", "documentation":"The details of the subscription with the newly added resources.
" }, "eTag":{ "shape":"String", "documentation":"The updated entity tag for concurrency control.
", "location":"header", "locationName":"ETag" } }, "payload":"subscription" }, "CancelSubscriptionChangeInput":{ "type":"structure", "required":[ "arn", "ifMatch" ], "members":{ "arn":{ "shape":"SubscriptionArn", "documentation":"The ARN of the subscription whose pending change you want to cancel.
" }, "ifMatch":{ "shape":"String", "documentation":"The ETag value from a previous GetSubscription or ListSubscriptions response.
A unique, case-sensitive identifier that you provide to ensure the request is handled only once.
", "idempotencyToken":true } } }, "CancelSubscriptionChangeOutput":{ "type":"structure", "required":[ "subscription", "eTag" ], "members":{ "subscription":{ "shape":"Subscription", "documentation":"The details of the subscription with the pending change removed.
" }, "eTag":{ "shape":"String", "documentation":"The updated entity tag for concurrency control.
", "location":"header", "locationName":"ETag" } }, "payload":"subscription" }, "CancelSubscriptionInput":{ "type":"structure", "required":[ "arn", "ifMatch" ], "members":{ "arn":{ "shape":"SubscriptionArn", "documentation":"The ARN of the subscription to cancel.
" }, "ifMatch":{ "shape":"String", "documentation":"The ETag value from a previous GetSubscription or ListSubscriptions response.
A unique, case-sensitive identifier that you provide to ensure the request is handled only once.
", "idempotencyToken":true } } }, "CancelSubscriptionOutput":{ "type":"structure", "required":[ "subscription", "eTag" ], "members":{ "subscription":{ "shape":"Subscription", "documentation":"The details of the subscription with the pending cancellation. For active subscriptions, a scheduledChange of type CANCELLATION is included.
The updated entity tag for concurrency control.
", "location":"header", "locationName":"ETag" } }, "payload":"subscription" }, "ConflictException":{ "type":"structure", "required":[ "message", "resourceId" ], "members":{ "message":{"shape":"String"}, "resourceId":{ "shape":"String", "documentation":"The identifier of the resource that has a conflicting state.
" } }, "documentation":"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.
The pricing plan family to subscribe to, such as CloudFront.
The tier level for the subscription, such as FREE, PRO, BUSINESS, or PREMIUM.
The usage level within the plan tier. Specify DEFAULT for the base configuration, or a higher level if your plan tier supports it.
The ARNs of the AWS resources to include in the subscription. Specify one or more supported resources.
For subscriptions in the CloudFront plan family, the resources must include exactly one Amazon CloudFront distribution and exactly one AWS WAF web ACL. You can also include other supported resources, such as Amazon Route 53 hosted zones and CloudFront KeyValueStores.
Determines whether the subscription requires explicit approval before billing starts. Set to MANUAL to require a separate ApprovePaidSubscription call, or IMMEDIATE to activate the subscription right away. Defaults to IMMEDIATE if not specified.
A unique, case-sensitive identifier that you provide to ensure that the request is handled only once. If you send the same request with the same client token, the API returns the original response without creating a duplicate subscription.
", "idempotencyToken":true } } }, "CreateSubscriptionOutput":{ "type":"structure", "required":[ "subscription", "eTag" ], "members":{ "subscription":{ "shape":"Subscription", "documentation":"The details of the newly created subscription.
" }, "eTag":{ "shape":"String", "documentation":"The entity tag for concurrency control. Use this value in the If-Match header for subsequent operations on this subscription.
The ARN of the subscription to remove resources from.
" }, "resourceArns":{ "shape":"ResourceArns", "documentation":"The ARNs of the resources to remove from the subscription. For subscriptions in the CloudFront plan family, you cannot remove the required CloudFront distribution or WAF web ACL.
" }, "ifMatch":{ "shape":"String", "documentation":"The ETag value from a previous GetSubscription or ListSubscriptions response.
A unique, case-sensitive identifier that you provide to ensure the request is handled only once.
", "idempotencyToken":true } } }, "DisassociateResourcesFromSubscriptionOutput":{ "type":"structure", "required":[ "subscription", "eTag" ], "members":{ "subscription":{ "shape":"Subscription", "documentation":"The details of the subscription with the specified resources removed.
" }, "eTag":{ "shape":"String", "documentation":"The updated entity tag for concurrency control.
", "location":"header", "locationName":"ETag" } }, "payload":"subscription" }, "GetSubscriptionInput":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"SubscriptionArn", "documentation":"The ARN of the subscription to retrieve.
" } } }, "GetSubscriptionOutput":{ "type":"structure", "required":[ "subscription", "eTag" ], "members":{ "subscription":{ "shape":"Subscription", "documentation":"The details of the requested subscription.
" }, "eTag":{ "shape":"String", "documentation":"The entity tag for concurrency control. Use this value in the If-Match header for subsequent operations on this subscription.
A unique, case-sensitive identifier that you provide to ensure a request is handled only once.
", "max":64, "min":1 }, "InternalServerException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"An unexpected error occurred on the server. Retry the request.
", "error":{"httpStatusCode":500}, "exception":true, "fault":true }, "ListSubscriptionsInput":{ "type":"structure", "members":{ "nextToken":{ "shape":"String", "documentation":"A token from a previous ListSubscriptions response. If the response included a nextToken, there are more results available. Pass this value to retrieve the next page of results.
The list of subscription summaries for the calling account.
" }, "nextToken":{ "shape":"String", "documentation":"A token that indicates there are more results available. Pass this value in a subsequent ListSubscriptions request to retrieve the next page of results.
A list of 1 to 10 AWS resource ARNs to include in the subscription.
", "max":10, "min":1 }, "ResourceNotFoundException":{ "type":"structure", "required":[ "message", "resourceId" ], "members":{ "message":{"shape":"String"}, "resourceId":{ "shape":"String", "documentation":"The identifier of the resource that was not found.
" } }, "documentation":"The specified subscription was not found. Verify that the ARN is correct and that the subscription belongs to your account.
", "error":{ "httpStatusCode":404, "senderFault":true }, "exception":true }, "ScheduledChange":{ "type":"structure", "required":["changeType"], "members":{ "changeType":{ "shape":"ScheduledChangeType", "documentation":"The type of pending change. Possible values are DOWNGRADE (a tier change to a lower level) and CANCELLATION (subscription termination).
The date and time when the change takes effect, in ISO 8601 format. This value is populated after the change is confirmed by the billing system.
" }, "planTier":{ "shape":"String", "documentation":"For downgrades, the tier level that the subscription will change to. Not present for cancellations.
" }, "usageLevel":{ "shape":"String", "documentation":"For downgrades, the target usage level after the change takes effect.
" } }, "documentation":"A pending change on a subscription that takes effect at the end of the current billing period, such as a tier downgrade or cancellation.
" }, "ScheduledChangeType":{ "type":"string", "documentation":"The type of pending change on a subscription.
Possible values:
DOWNGRADE — The subscription tier is being lowered at the end of the billing period.
CANCELLATION — The subscription is being terminated at the end of the billing period.
The request would exceed a service limit. You have reached the maximum number of subscriptions allowed for your account.
", "error":{ "httpStatusCode":402, "senderFault":true }, "exception":true }, "Status":{ "type":"string", "documentation":"The status of a flat-rate pricing subscription.
Possible values:
PENDING_APPROVAL — The subscription was created with manual approval and is waiting for an ApprovePaidSubscription call.
ACTIVE — The subscription is active and resources are covered by flat-rate pricing.
SYNC_IN_PROGRESS — A change is being applied to the subscription. Wait for the operation to complete before making additional changes.
FAILED — The subscription encountered an error. Check the statusReason field for details.
The Amazon Resource Name (ARN) that uniquely identifies this subscription.
" }, "planFamily":{ "shape":"String", "documentation":"The pricing plan family for the subscription, such as CloudFront.
The current tier level of the pricing plan, such as FREE, PRO, BUSINESS, or PREMIUM.
The usage level within the plan tier. When present, indicates a specific capacity configuration beyond the base tier.
" }, "scheduledChange":{ "shape":"ScheduledChange", "documentation":"A pending change that will take effect at the end of the current billing period. This field is present only when a downgrade or cancellation is scheduled.
" }, "status":{ "shape":"Status", "documentation":"The current status of the subscription. For the list of possible values, see the Status type.
A human-readable explanation of the current status, present when additional context is available.
" }, "resourceArns":{ "shape":"ResourceArns", "documentation":"The ARNs of the AWS resources covered by this subscription.
" }, "createdAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The date and time when the subscription was created, in ISO 8601 format.
" }, "updatedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The date and time when the subscription was last modified, in ISO 8601 format.
" } }, "documentation":"The full details of a flat-rate pricing subscription, including its current configuration, status, and associated resources.
" }, "SubscriptionArn":{ "type":"string", "documentation":"The Amazon Resource Name (ARN) of a flat-rate pricing subscription.
", "max":2048, "min":1 }, "SubscriptionSummary":{ "type":"structure", "required":[ "arn", "planFamily", "planTier", "status", "resourceArns", "createdAt", "updatedAt", "eTag" ], "members":{ "arn":{ "shape":"SubscriptionArn", "documentation":"The Amazon Resource Name (ARN) that uniquely identifies this subscription.
" }, "planFamily":{ "shape":"String", "documentation":"The pricing plan family for the subscription, such as CloudFront.
The current tier level of the pricing plan.
" }, "usageLevel":{ "shape":"String", "documentation":"The usage level within the plan tier.
" }, "scheduledChange":{ "shape":"ScheduledChange", "documentation":"A pending change that will take effect at the end of the current billing period, if any.
" }, "status":{ "shape":"Status", "documentation":"The current status of the subscription.
" }, "statusReason":{ "shape":"String", "documentation":"A human-readable explanation of the current status, present when additional context is available.
" }, "resourceArns":{ "shape":"ResourceArns", "documentation":"The ARNs of the AWS resources covered by this subscription.
" }, "createdAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The date and time when the subscription was created, in ISO 8601 format.
" }, "updatedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The date and time when the subscription was last modified, in ISO 8601 format.
" }, "eTag":{ "shape":"String", "documentation":"The entity tag for concurrency control. Pass this value in the If-Match header when making changes to this subscription.
Summary information for a flat-rate pricing subscription, as returned by list operations.
" }, "SubscriptionSummaryList":{ "type":"list", "member":{"shape":"SubscriptionSummary"} }, "SyntheticTimestamp_date_time":{ "type":"timestamp", "timestampFormat":"iso8601" }, "ThrottlingException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"The request rate exceeds the allowed limit. Wait briefly and retry the request.
", "error":{ "httpStatusCode":429, "senderFault":true }, "exception":true }, "UpdateSubscriptionInput":{ "type":"structure", "required":[ "arn", "planTier", "ifMatch" ], "members":{ "arn":{ "shape":"SubscriptionArn", "documentation":"The ARN of the subscription to update.
" }, "planTier":{ "shape":"String", "documentation":"The new tier level for the subscription.
" }, "usageLevel":{ "shape":"String", "documentation":"The usage level within the plan tier. Specify DEFAULT for the base configuration. If omitted, the usage level is reset to the default.
The ETag value from a previous GetSubscription or ListSubscriptions response. This ensures you are updating the expected version of the subscription.
A unique, case-sensitive identifier that you provide to ensure the request is handled only once.
", "idempotencyToken":true } } }, "UpdateSubscriptionOutput":{ "type":"structure", "required":[ "subscription", "eTag" ], "members":{ "subscription":{ "shape":"Subscription", "documentation":"The details of the updated subscription. For downgrades, the current tier remains unchanged and a scheduledChange indicates the pending change.
The updated entity tag for concurrency control.
", "location":"header", "locationName":"ETag" } }, "payload":"subscription" }, "ValidationException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"}, "resourceId":{ "shape":"String", "documentation":"The identifier of the resource that failed validation.
" } }, "documentation":"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.
", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true } }, "documentation":"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.
" }