Skip to content

get_application_session_configuration async

get_application_session_configuration(
    application_arn: ApplicationArn,
    *,
    config_overrides: Optional[AsyncSSOAdminClientConfig] = None,
) -> GetApplicationSessionConfigurationResponse

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.

Parameters:

  • application_arn (ApplicationArn) –

    The Amazon Resource Name (ARN) of the application for which to retrieve the session configuration.

Raises:

Source code in docs_src/capo_sso_admin/_services/async_sso_admin.py
async def get_application_session_configuration(
    self,
    application_arn: "capo_sso_admin.types.application_arn.ApplicationArn",
    *,
    config_overrides: Optional[AsyncSSOAdminClientConfig] = None,
) -> "capo_sso_admin.types.get_application_session_configuration_response.GetApplicationSessionConfigurationResponse":
    """<p>Retrieves the session configuration for an application in IAM Identity Center.</p> <p>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.</p>

    Args:
        application_arn: <p>The Amazon Resource Name (ARN) of the application for which to retrieve the session configuration.</p>

    Raises:
        capo_sso_admin.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_sso_admin.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception, or failure with an internal server.</p>
        capo_sso_admin.errors.resource_not_found_exception.ResourceNotFoundException: <p>Indicates that a requested resource is not found.</p>
        capo_sso_admin.errors.throttling_exception.ThrottlingException: <p>Indicates that the principal has crossed the throttling limits of the API operations.</p>
        capo_sso_admin.errors.validation_exception.ValidationException: <p>The request failed because it contains a syntax error.</p>
        capo_sso_admin.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_sso_admin.types.get_application_session_configuration_request.GetApplicationSessionConfigurationRequest]",
    ) -> AsyncOperationResponse[
        "capo_sso_admin.types.get_application_session_configuration_response.GetApplicationSessionConfigurationResponse"
    ]:
        import capo_sso_admin._operations.swb_external_service.get_application_session_configuration

        (
            output,
            http_response,
        ) = await capo_sso_admin._operations.swb_external_service.get_application_session_configuration.async_get_application_session_configuration(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetApplicationSessionConfiguration")
    )
    input_: capo_sso_admin.types.get_application_session_configuration_request.GetApplicationSessionConfigurationRequest = {
        "application_arn": application_arn
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output