Skip to main content

user_access_tasks

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

Overview​

Nameuser_access_tasks
TypeResource
Idaws.appfabric.user_access_tasks

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
user_access_results_listarrayContains a list of user access results.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
batch_get_user_access_tasksselectregionGets user access details in a batch request. This action polls data from the tasks that are kicked off by the StartUserAccessTasks action.
start_user_access_tasksexecregion, appBundleIdentifier, emailStarts the tasks to search user access status for a specific email address. The tasks are stopped when the user access status data is found. The tasks are terminated when the API calls to the application time out.

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.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples​

Gets user access details in a batch request. This action polls data from the tasks that are kicked off by the StartUserAccessTasks action.

SELECT
user_access_results_list
FROM aws.appfabric.user_access_tasks
WHERE region = '{{ region }}' -- required
;

Lifecycle Methods​

Starts the tasks to search user access status for a specific email address. The tasks are stopped when the user access status data is found. The tasks are terminated when the API calls to the application time out.

EXEC aws.appfabric.user_access_tasks.start_user_access_tasks
@region='{{ region }}' --required
@@json=
'{
"appBundleIdentifier": "{{ appBundleIdentifier }}",
"email": "{{ email }}"
}'
;