approved_origins

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

Overview

Name	approved_origins
Type	Resource
Id	aws.connect.approved_origins

Fields

The following fields are returned by SELECT queries:

list_approved_origins

Name	Datatype	Description
origin	string	The approved origins.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_approved_origins	select	instance_id, region	nextToken, maxResults	This API is in preview release for Connect Customer and is subject to change. Returns a paginated list of all approved origins associated with the instance.
disassociate_approved_origin	update	instance_id, origin, region	clientToken	This API is in preview release for Connect Customer and is subject to change. Revokes access to integrated applications from Connect Customer.
associate_approved_origin	update	instance_id, region		This API is in preview release for Connect Customer and is subject to change. Associates an approved origin to an Connect Customer instance.

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
instance_id	string	The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
origin	string	The domain URL of the integrated application.
region	string	AWS region (default: us-east-1)
clientToken	string	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
maxResults	integer	The maximum number of results to return per page.
nextToken	string	The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

SELECT examples

list_approved_origins

This API is in preview release for Connect Customer and is subject to change. Returns a paginated list of all approved origins associated with the instance.

SELECT
origin
FROM aws.connect.approved_origins
WHERE instance_id = '{{ instance_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

UPDATE examples

disassociate_approved_origin

This API is in preview release for Connect Customer and is subject to change. Revokes access to integrated applications from Connect Customer.

UPDATE aws.connect.approved_origins
SET 
-- No updatable properties
WHERE 
instance_id = '{{ instance_id }}' --required
AND origin = '{{ origin }}' --required
AND region = '{{ region }}' --required
AND clientToken = '{{ clientToken}}';

associate_approved_origin

This API is in preview release for Connect Customer and is subject to change. Associates an approved origin to an Connect Customer instance.

UPDATE aws.connect.approved_origins
SET 
Origin = '{{ Origin }}',
ClientToken = '{{ ClientToken }}'
WHERE 
instance_id = '{{ instance_id }}' --required
AND region = '{{ region }}' --required;