subscriptions

Creates, updates, deletes, gets or lists a subscriptions resource.

Overview

Name	subscriptions
Type	Resource
Id	aws.connecthealth.subscriptions

Fields

The following fields are returned by SELECT queries:

get_subscription

Name	Datatype	Description
activated_at	string (date-time)
arn	string	(pattern: <code>arn:aws:health-agent:[a-z0-9-]+:[0-9]{12}:domain/(hai-|dom-)[a-z0-9]+/subscription/sub-[a-zA-Z0-9]{21}</code>)
created_at	string (date-time)
deactivated_at	string (date-time)
domain_id	string	(pattern: <code>(hai-|dom-)[a-z0-9]+</code>)
last_updated_at	string (date-time)
status	string	(ACTIVE, INACTIVE, DELETED)
subscription_id	string	(pattern: <code>sub-[a-zA-Z0-9]{21}</code>)

list_subscriptions

Name	Datatype	Description
activated_at	string (date-time)
arn	string	(pattern: <code>arn:aws:health-agent:[a-z0-9-]+:[0-9]{12}:domain/(hai-|dom-)[a-z0-9]+/subscription/sub-[a-zA-Z0-9]{21}</code>)
created_at	string (date-time)
deactivated_at	string (date-time)
domain_id	string	(pattern: <code>(hai-|dom-)[a-z0-9]+</code>)
last_updated_at	string (date-time)
status	string	(ACTIVE, INACTIVE, DELETED)
subscription_id	string	(pattern: <code>sub-[a-zA-Z0-9]{21}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_subscription	select	domain_id, subscription_id, region		Retrieves information about a Subscription.
list_subscriptions	select	domain_id, region	maxResults, nextToken	Lists all Subscriptions within a Domain.
create_subscription	insert	domain_id, region		Creates a new Subscription within a Domain for billing and user management.
activate_subscription	exec	domain_id, subscription_id, region		Activates a Subscription to enable billing for a user.
deactivate_subscription	exec	domain_id, subscription_id, region		Deactivates a Subscription to stop billing for a user.

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
domain_id	string	The unique identifier of the parent Domain.
region	string	AWS region (default: us-east-1)
subscription_id	string	The unique identifier of the Subscription.
maxResults	integer	Maximum number of results to return.
nextToken	string	Token for pagination.

SELECT examples

get_subscription

Retrieves information about a Subscription.

SELECT
activated_at,
arn,
created_at,
deactivated_at,
domain_id,
last_updated_at,
status,
subscription_id
FROM aws.connecthealth.subscriptions
WHERE domain_id = '{{ domain_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND region = '{{ region }}' -- required
;

list_subscriptions

Lists all Subscriptions within a Domain.

SELECT
activated_at,
arn,
created_at,
deactivated_at,
domain_id,
last_updated_at,
status,
subscription_id
FROM aws.connecthealth.subscriptions
WHERE domain_id = '{{ domain_id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_subscription

Creates a new Subscription within a Domain for billing and user management.

INSERT INTO aws.connecthealth.subscriptions (
domain_id,
region
)
SELECT 
'{{ domain_id }}',
'{{ region }}'
RETURNING
activated_at,
arn,
created_at,
deactivated_at,
domain_id,
last_updated_at,
status,
subscription_id
;

Manifest

# Description fields are for documentation purposes
- name: subscriptions
props:
  - name: domain_id
    value: "{{ domain_id }}"
    description: Required parameter for the subscriptions resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the subscriptions resource.

Lifecycle Methods

activate_subscription

Activates a Subscription to enable billing for a user.

EXEC aws.connecthealth.subscriptions.activate_subscription 
@domain_id='{{ domain_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@region='{{ region }}' --required
;

deactivate_subscription

Deactivates a Subscription to stop billing for a user.

EXEC aws.connecthealth.subscriptions.deactivate_subscription 
@domain_id='{{ domain_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@region='{{ region }}' --required
;