notification_subscriptions

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

Overview

Name	notification_subscriptions
Type	Resource
Id	aws.workdocs.notification_subscriptions

Fields

The following fields are returned by SELECT queries:

describe_notification_subscriptions

Name	Datatype	Description
end_point	string	The endpoint of the subscription.
protocol	string	The protocol of the subscription. (HTTPS, SQS)
subscription_id	string	The ID of the subscription. (pattern: <code>[&\w+-.@]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_notification_subscriptions	select	organization_id, region	marker, limit	Lists the specified notification subscriptions.
create_notification_subscription	insert	organization_id, region, Endpoint, SubscriptionType		Configure Amazon WorkDocs to use Amazon SNS notifications. The endpoint receives a confirmation message, and must confirm the subscription. For more information, see Setting up notifications for an IAM user or role in the Amazon WorkDocs Developer Guide.
delete_notification_subscription	delete	subscription_id, organization_id, region		Deletes the specified subscription from the specified organization.

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
organization_id	string	The ID of the organization.
region	string	AWS region (default: us-east-1)
subscription_id	string	The ID of the subscription.
limit	integer	The maximum number of items to return with this call.
marker	string	The marker for the next set of results. (You received this marker from a previous call.)

SELECT examples

describe_notification_subscriptions

Lists the specified notification subscriptions.

SELECT
end_point,
protocol,
subscription_id
FROM aws.workdocs.notification_subscriptions
WHERE organization_id = '{{ organization_id }}' -- required
AND region = '{{ region }}' -- required
AND marker = '{{ marker }}'
AND limit = '{{ limit }}'
;

INSERT examples

create_notification_subscription

Configure Amazon WorkDocs to use Amazon SNS notifications. The endpoint receives a confirmation message, and must confirm the subscription. For more information, see Setting up notifications for an IAM user or role in the Amazon WorkDocs Developer Guide.

INSERT INTO aws.workdocs.notification_subscriptions (
Endpoint,
Protocol,
SubscriptionType,
organization_id,
region
)
SELECT 
'{{ Endpoint }}' /* required */,
'{{ Protocol }}',
'{{ SubscriptionType }}' /* required */,
'{{ organization_id }}',
'{{ region }}'
RETURNING
subscription
;

Manifest

# Description fields are for documentation purposes
- name: notification_subscriptions
props:
  - name: organization_id
    value: "{{ organization_id }}"
    description: Required parameter for the notification_subscriptions resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the notification_subscriptions resource.
  - name: Endpoint
    value: "{{ Endpoint }}"
  - name: Protocol
    value: "{{ Protocol }}"
    valid_values: ['HTTPS', 'SQS']
  - name: SubscriptionType
    value: "{{ SubscriptionType }}"
    valid_values: ['ALL']

DELETE examples

delete_notification_subscription

Deletes the specified subscription from the specified organization.

DELETE FROM aws.workdocs.notification_subscriptions
WHERE subscription_id = '{{ subscription_id }}' --required
AND organization_id = '{{ organization_id }}' --required
AND region = '{{ region }}' --required
;