organizational_units

Creates, updates, deletes, gets or lists an organizational_units resource.

Overview

Name	organizational_units
Type	Resource
Id	aws.notifications.organizational_units

Fields

The following fields are returned by SELECT queries:

list_organizational_units

Name	Datatype	Description
organizational_unit	string	The list of organizational units that match the specified criteria.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_organizational_units	select	notificationConfigurationArn, region	maxResults, nextToken	Returns a list of organizational units associated with a notification configuration.
associate_organizational_unit	update	organizational_unit_id, region, notificationConfigurationArn		Associates an organizational unit with a notification configuration.
disassociate_organizational_unit	exec	organizational_unit_id, region, notificationConfigurationArn		Removes the association between an organizational unit and a notification configuration.

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
notificationConfigurationArn	string	The Amazon Resource Name (ARN) of the notification configuration used to filter the organizational units.
organizational_unit_id	string	The unique identifier of the organizational unit to disassociate.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of organizational units to return in a single call. Valid values are 1-100.
nextToken	string	The token for the next page of results. Use the value returned in the previous response.

SELECT examples

list_organizational_units

Returns a list of organizational units associated with a notification configuration.

SELECT
organizational_unit
FROM aws.notifications.organizational_units
WHERE notificationConfigurationArn = '{{ notificationConfigurationArn }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

UPDATE examples

associate_organizational_unit

Associates an organizational unit with a notification configuration.

UPDATE aws.notifications.organizational_units
SET 
notificationConfigurationArn = '{{ notificationConfigurationArn }}'
WHERE 
organizational_unit_id = '{{ organizational_unit_id }}' --required
AND region = '{{ region }}' --required
AND notificationConfigurationArn = '{{ notificationConfigurationArn }}' --required;

Lifecycle Methods

disassociate_organizational_unit

Removes the association between an organizational unit and a notification configuration.

EXEC aws.notifications.organizational_units.disassociate_organizational_unit 
@organizational_unit_id='{{ organizational_unit_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"notificationConfigurationArn": "{{ notificationConfigurationArn }}"
}'
;