subscriptions
Creates, updates, deletes, gets or lists a subscriptions resource.
Overview
| Name | subscriptions |
| Type | Resource |
| Id | aws.codecatalyst.subscriptions |
Fields
The following fields are returned by SELECT queries:
- get_subscription
| Name | Datatype | Description |
|---|---|---|
aws_account_name | string | The display name of the Amazon Web Services account used for billing for the space. (pattern: <code>[a-zA-Z0-9]+(?:[-_.][a-zA-Z0-9]+)*</code>) |
pending_subscription_start_time | string (date-time) | The day and time the pending change will be applied to the space, in coordinated universal time (UTC) timestamp format as specified in RFC 3339. |
pending_subscription_type | string | The type of the billing plan that the space will be changed to at the start of the next billing cycle. This applies only to changes that reduce the functionality available for the space. Billing plan changes that increase functionality are applied immediately. For more information, see Pricing. |
subscription_type | string | The type of the billing plan for the space. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_subscription | select | space_name, region | Returns information about the Amazon Web Services account used for billing purposes and the billing plan for the space. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
space_name | string | The name of the space. |
SELECT examples
- get_subscription
Returns information about the Amazon Web Services account used for billing purposes and the billing plan for the space.
SELECT
aws_account_name,
pending_subscription_start_time,
pending_subscription_type,
subscription_type
FROM aws.codecatalyst.subscriptions
WHERE space_name = '{{ space_name }}' -- required
AND region = '{{ region }}' -- required
;