application_session_configurations

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

Overview

Name	application_session_configurations
Type	Resource
Id	aws.sso_admin.application_session_configurations

Fields

The following fields are returned by SELECT queries:

get_application_session_configuration

Name	Datatype	Description
user_background_session_application_status	string	The status of user background sessions for the application. (ENABLED, DISABLED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_application_session_configuration	select	region		Retrieves the session configuration for an application in IAM Identity Center. The session configuration determines how users can access an application. This includes whether user background sessions are enabled. User background sessions allow users to start a job on a supported Amazon Web Services managed application without having to remain signed in to an active session while the job runs.
put_application_session_configuration	replace	region, ApplicationArn		Updates the session configuration for an application in IAM Identity Center. The session configuration determines how users can access an application. This includes whether user background sessions are enabled. User background sessions allow users to start a job on a supported Amazon Web Services managed application without having to remain signed in to an active session while the job runs.

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
region	string	AWS region (default: us-east-1)

SELECT examples

get_application_session_configuration

Retrieves the session configuration for an application in IAM Identity Center. The session configuration determines how users can access an application. This includes whether user background sessions are enabled. User background sessions allow users to start a job on a supported Amazon Web Services managed application without having to remain signed in to an active session while the job runs.

SELECT
user_background_session_application_status
FROM aws.sso_admin.application_session_configurations
WHERE region = '{{ region }}' -- required
;

REPLACE examples

put_application_session_configuration

Updates the session configuration for an application in IAM Identity Center. The session configuration determines how users can access an application. This includes whether user background sessions are enabled. User background sessions allow users to start a job on a supported Amazon Web Services managed application without having to remain signed in to an active session while the job runs.

REPLACE aws.sso_admin.application_session_configurations
SET 
ApplicationArn = '{{ ApplicationArn }}',
UserBackgroundSessionApplicationStatus = '{{ UserBackgroundSessionApplicationStatus }}'
WHERE 
region = '{{ region }}' --required
AND ApplicationArn = '{{ ApplicationArn }}' --required;