Skip to content

put_application_session_configuration

put_application_session_configuration(
    application_arn: ApplicationArn,
    *,
    config_overrides: Optional[SSOAdminClientConfig] = None,
    user_background_session_application_status: Optional[
        UserBackgroundSessionApplicationStatus
    ] = None,
) -> PutApplicationSessionConfigurationResponse

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:

  • application_arn (ApplicationArn) –

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

  • user_background_session_application_status (Optional[UserBackgroundSessionApplicationStatus], default: None ) –

    The status of user background sessions for the application.

Raises:

  • AccessDeniedException –

    You do not have sufficient access to perform this action.

  • ConflictException –

    Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

  • InternalServerException –

    The request processing has failed because of an unknown error, exception, or failure with an internal server.

  • ResourceNotFoundException –

    Indicates that a requested resource is not found.

  • ThrottlingException –

    Indicates that the principal has crossed the throttling limits of the API operations.

  • ValidationException –

    The request failed because it contains a syntax error.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_sso_admin/_services/sso_admin.py
def put_application_session_configuration(
    self,
    application_arn: "capo_sso_admin.types.application_arn.ApplicationArn",
    *,
    config_overrides: Optional[SSOAdminClientConfig] = None,
    user_background_session_application_status: Optional[
        "capo_sso_admin.types.user_background_session_application_status.UserBackgroundSessionApplicationStatus"
    ] = None,
) -> "capo_sso_admin.types.put_application_session_configuration_response.PutApplicationSessionConfigurationResponse":
    """<p>Updates 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 update the session configuration.</p>
        user_background_session_application_status: <p>The status of user background sessions for the application.</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.conflict_exception.ConflictException: <p>Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.</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.
    """

    def _handler(
        req: "OperationRequest[capo_sso_admin.types.put_application_session_configuration_request.PutApplicationSessionConfigurationRequest]",
    ) -> OperationResponse[
        "capo_sso_admin.types.put_application_session_configuration_response.PutApplicationSessionConfigurationResponse"
    ]:
        import capo_sso_admin._operations.swb_external_service.put_application_session_configuration

        output, http_response = (
            capo_sso_admin._operations.swb_external_service.put_application_session_configuration.put_application_session_configuration(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PutApplicationSessionConfiguration")
    )
    input_: capo_sso_admin.types.put_application_session_configuration_request.PutApplicationSessionConfigurationRequest = {
        "application_arn": application_arn
    }
    if user_background_session_application_status is not None:
        input_["user_background_session_application_status"] = (
            user_background_session_application_status
        )

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output