View a markdown version of this page

Subscription management - Amazon Connect Health

Subscription management

A subscription associates a provider with the ambient documentation agent. You need an active subscription before you can start a streaming session.

Create a subscription

To create a subscription, call the CreateSubscription API operation. This generates a unique subscriptionId that you use to authorize the user and start streaming sessions. Subscriptions are automatically created in activated mode.

Tip

Create the subscription on the user’s first use to align subscription start with actual usage.

Deactivate a subscription

To temporarily stop a subscription from accepting new streaming sessions, call the DeactivateSubscription API operation. A deactivated subscription retains its configuration and can be reactivated later. In-progress streams complete normally.

Important

Deactivating a subscription immediately forfeits any remaining free trial period. If a subscription that was deactivated during a free trial is reactivated later, it is reactivated as a paid subscription.

Reactivate a subscription

Deactivated subscriptions can be reactivated by calling the ActivateSubscription API operation with the subscriptionId. Paid metering begins immediately upon reactivation.